GET /distributors
Bearer auth

Get paginated list of distributors (Owner only)

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 distributors by

    Values are name, description, created_at, updated_at, or suspended_at.

  • sort_direction string

    Sort direction

    Values are asc or desc. Default value is asc.

  • status string

    Filter organizations by status (enabled = not suspended, blocked = suspended)

    Values are enabled or blocked.

Responses

  • 200 application/json

    Distributors retrieved successfully

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

          Database UUID of the organization

        • logto_id string

          Logto organization ID (use this value for assignment operations)

        • name string

          Organization name

        • description string

          Organization description

        • custom_data object

          Custom organization data

          Additional properties are allowed.

        • suspended_at string(date-time) | null

          Timestamp when the organization was suspended. NULL means enabled, non-NULL means blocked/suspended.

        • suspended_by_org_id string | null

          Organization ID that caused cascade suspension (for resellers and customers only). NULL means directly suspended or not suspended. When set, the entity can only be reactivated by the parent organization that initiated the cascade.

        • rebranding_enabled boolean

          Whether rebranding is active for this organization (directly or inherited from parent)

        • rebranding_org_id string | null

          The organization ID that provides the rebranding (the org where rebranding is configured). Only present when rebranding_enabled is true.

      • 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 /distributors 
curl \
 --request GET 'https://collect.your-domain.com/api/distributors' \
 --header "Authorization: Bearer $ACCESS_TOKEN"
Response examples (200) 
{
  "code": 200,
  "message": "distributors retrieved successfully",
  "data": {
    "distributors": [
      {
        "id": "4405ffd0-0aca-44ef-bae2-c8545bce94f4",
        "logto_id": "akkbs6x2wo82",
        "name": "ACME Distribution SpA",
        "description": "Main distributor for Italian and Swiss markets",
        "custom_data": {
          "email": "contact@acme-distribution.com",
          "region": "Italy",
          "contactPerson": "John Smith"
        },
        "suspended_at": "2026-05-04T09:42:00Z",
        "suspended_by_org_id": "string",
        "rebranding_enabled": false,
        "rebranding_org_id": "string"
      }
    ],
    "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": {}
}