elmo
Sign up

List brands

GET
/brands

Authorization

BearerAuth
headerAuthorizationBearer <token>

An instance admin key from ADMIN_API_KEYS, or an organization key (elmo_…) issued from the dashboard.

Query Parameters

page?integer

Page number, 1-based.

Range1 <= value
Default1
limit?integer

Items per page. Values above the maximum are clamped, not rejected.

Range1 <= value <= 100
Default20

Response Body

Paginated list of brands

application/json
  1. response
data*array<>

The items on this page. Read this rather than the named key below.

brands*array<>Deprecated

Deprecated: read data instead. Kept while the one known consumer migrates, and removed in a future release.

pagination*
Example Request
curl -X GET 'https://app.elmohq.com/api/v1/brands'
Example Response
{  "data": [    {      "id": "string",      "name": "string",      "domains": [        "string"      ],      "aliases": [        "string"      ],      "enabled": true,      "onboarded": true,      "createdAt": "2019-08-24T14:15:22Z",      "updatedAt": "2019-08-24T14:15:22Z",      "organizationId": "string",      "enabledModels": [        "string"      ],      "delayOverrideHours": 0    }  ],  "brands": [    {      "id": "string",      "name": "string",      "domains": [        "string"      ],      "aliases": [        "string"      ],      "enabled": true,      "onboarded": true,      "createdAt": "2019-08-24T14:15:22Z",      "updatedAt": "2019-08-24T14:15:22Z",      "organizationId": "string",      "enabledModels": [        "string"      ],      "delayOverrideHours": 0    }  ],  "pagination": {    "page": 0,    "limit": 0,    "total": 0,    "totalPages": 0  }}