Get single distributor

GET /distributors/{id}
Bearer auth

Get a specific distributor by ID (Owner only)

Path parameters

  • id string Required

    Distributor organization ID

Responses

  • 200 application/json

    Distributor retrieved successfully

    Hide response attributes Show response attributes object
    • code integer
    • message string
    • data object
      Hide data attributes Show data 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
  • 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
  • 404 application/json

    Resource not found

    Hide response attributes Show response attributes object
    • code integer

      HTTP error code

    • message string

      Error message

    • data object
      Hide data attributes Show data attributes object
      • type string

        Type of error

        Values are validation_error or external_api_error.

      • errors array[object]
        Hide errors attributes Show errors attributes object
        • key string

          Field name that failed validation

        • message string

          Error code or message

        • value string

          Value that failed validation

      • details

        Additional error details
GET /distributors/{id} 
curl \
 --request GET 'https://api.your-domain.com/api/distributors/org_123456789' \
 --header "Authorization: Bearer $ACCESS_TOKEN"
Response examples (200) 
{
  "code": 200,
  "message": "distributor retrieved successfully",
  "data": {
    "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"
    }
  }
}
Response examples (401) 
{
  "code": 401,
  "message": "invalid token",
  "data": {}
}
Response examples (403) 
{
  "code": 403,
  "message": "insufficient permissions",
  "data": {}
}
Response examples (404) 
{
  "code": 400,
  "message": "validation failed",
  "data": {
    "type": "validation_error",
    "errors": [
      {
        "key": "username",
        "message": "required",
        "value": "string"
      }
    ]
  }
}