GET /customers

Lists customers with filtering and pagination options.

GET/customers

Get customers

Headers

Bearer access token returned by the authentication endpoint.

The API key used for authentication when making requests to the API Gateway.

API version selector for Conomy endpoints. Use 24-04-2025 for the current version.

Identifies the application making the request.

Query parameters

Comma separated id to list customers for.

Comma separated type to list customers for.

Comma separated identityId to list customers for.

Specifies the maximum number of items to return in a single request.

A cursor indicating the position of the last retrieved item.

A cursor indicating how many items to skip from the request

Free-text operational search. When omitted or blank, the endpoint uses the canonical listing path. A non-blank value must contain 2 to 200 characters after trimming and is resolved through the eventually-consistent search read model. Existing filters and authorization scopes still apply.

Responses

paginationobjectrequired

Cursor-based pagination metadata (limit, cursor, hasMore).

resultsobject[]required

Items from the current page

Request

GET /sandbox/customers HTTP/1.1
Host: api.conomyhq.com
Authorization: Bearer {ACCESS_TOKEN}
x-api-key: {YOUR_API_KEY}
conomyhq-api-version: 24-04-2025
User-Agent: MyApp/1.0

package main

import (
	"encoding/json"
	"net/http"
)

func main() {
	req, _ := http.NewRequest("GET", "https://api.conomyhq.com/sandbox/customers", nil)
	req.Header.Set("Authorization", "Bearer {ACCESS_TOKEN}")
	req.Header.Set("x-api-key", "{YOUR_API_KEY}")
	req.Header.Set("conomyhq-api-version", "24-04-2025")
	req.Header.Set("User-Agent", "MyApp/1.0")

	client := &http.Client{}
	resp, _ := client.Do(req)
	defer resp.Body.Close()

	var data map[string]any
	json.NewDecoder(resp.Body).Decode(&data)
}

use reqwest::Client;
use serde_json::json;

#[tokio::main]
async fn main() -> Result<(), Box<dyn std::error::Error>> {
    let client = Client::new();
    let resp = client
        .get("https://api.conomyhq.com/sandbox/customers")
        .header("Authorization", "Bearer {ACCESS_TOKEN}")
        .header("x-api-key", "{YOUR_API_KEY}")
        .header("conomyhq-api-version", "24-04-2025")
        .header("User-Agent", "MyApp/1.0")
        .send()
        .await?;

    let data: serde_json::Value = resp.json().await?;
    Ok(())
}

Response

{
  "pagination": {
    "count": 0,
    "next": 0,
    "previous": 0,
    "total": 0
  },
  "results": [
    {
      "firstName": "string"
    }
  ]
}