List customers

GET /customers
Bearer auth

Get paginated list of customers (Owner + Distributor + Reseller)

Query parameters

  • page integer

    Page number

    Minimum value is 1. Default value is 1.

  • page_size integer

    Items per page

    Minimum value is 1, maximum value is 100. Default value is 20.

  • sort_by string

    Field to sort customers by

    Values are name, description, created_at, or updated_at.

  • sort_direction string

    Sort direction

    Values are asc or desc. Default value is asc.

Responses

  • 200 application/json

    Customers retrieved successfully

    Hide response attributes Show response attributes object
    • code integer
    • message string
    • data object
      Hide data attributes Show data attributes object
      • customers array[object]
        Hide customers attributes Show customers attributes object
        • id string

          Organization ID

        • name string

          Organization name

        • description string

          Organization description

        • custom_data object

          Custom organization data

          Additional properties are allowed.

        • branding object
          Hide branding attributes Show branding attributes object
          • logo_url string

            Organization logo URL

          • dark_logo_url string

            Organization dark theme logo URL

      • pagination object
        Hide pagination attributes Show pagination attributes object
        • page integer

          Current page number

          Minimum value is 1.

        • page_size integer

          Number of items per page

          Minimum value is 1, maximum value is 100.

        • total_count integer

          Total number of items

          Minimum value is 0.

        • total_pages integer

          Total number of pages

          Minimum value is 0.

        • has_next boolean

          Whether there is a next page

        • has_prev boolean

          Whether there is a previous page

        • next_page integer | null

          Next page number if available

        • prev_page integer | null

          Previous page number if available

        • sort_by string | null

          Field used for sorting

        • sort_direction string | null

          Sort direction

          Values are asc or desc.
  • 401 application/json

    Unauthorized - invalid or missing token

    Hide response attributes Show response attributes object
    • code integer
    • message string
    • data object | null
  • 403 application/json

    Forbidden - insufficient permissions

    Hide response attributes Show response attributes object
    • code integer
    • message string
    • data object | null
GET /customers 
curl \
 --request GET 'https://collect.your-domain.com/api/customers' \
 --header "Authorization: Bearer $ACCESS_TOKEN"
Response examples (200) 
{
  "code": 200,
  "message": "customers retrieved successfully",
  "data": {
    "customers": [
      {
        "id": "org_123456789",
        "name": "ACME Distribution SpA",
        "description": "Main distributor for Italian and Swiss markets",
        "custom_data": {
          "email": "contact@acme-distribution.com",
          "region": "Italy",
          "contactPerson": "John Smith"
        },
        "branding": {
          "logo_url": "https://cdn.example.com/logos/org-console.png",
          "dark_logo_url": "https://cdn.example.com/logos/org-console-dark.png"
        }
      }
    ],
    "pagination": {
      "page": 1,
      "page_size": 20,
      "total_count": 156,
      "total_pages": 8,
      "has_next": true,
      "has_prev": false,
      "next_page": 2,
      "prev_page": 42,
      "sort_by": "name",
      "sort_direction": "asc"
    }
  }
}
Response examples (401) 
{
  "code": 401,
  "message": "invalid token",
  "data": {}
}
Response examples (403) 
{
  "code": 403,
  "message": "insufficient permissions",
  "data": {}
}