List brands/clients

get/api/v1/brands

Request

Base URL: https://www.poster.ly
URL: https://www.poster.ly/api/v1/brands
Auth: HTTP bearer

Query parameters

workspace_idstring

Filter to brands in a specific workspace.

Response

Brands fetched successfully

Example response

{
  "brands": [
    {
      "id": "9f6d99a4-b0e0-4ee0-8949-6a87786a52cc",
      "name": "Grassroots",
      "workspace_id": "2d0a6d4c-9eef-4ee2-9026-2ca0dc29c8d6",
      "workspace_client_id": "9f6d99a4-b0e0-4ee0-8949-6a87786a52cc",
      "source": "canonical",
      "account_count": 2
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.