Admin APIs

Get Brands

GET /brands
Api key auth

Get a list of brands

Query parameters

  • page integer(int32)

    Page Number

  • limit integer(int32)

    Number of items per page

Responses

  • 200 application/json

    A list of brands

    Hide response attributes Show response attributes object
    • pagination object
      Hide pagination attributes Show pagination attributes object
      • current integer(int32)
      • previous integer(int32)
      • next integer(int32)
      • limit integer(int32)
      • total_pages integer(int32)
      • total_count integer(int32)
    • data array[object]
      Hide data attributes Show data attributes object
      • id string(guid)

        System generated unique identifier. Don't include this in POST request body.

      • handle string
      • title string
      • description string | null
      • created_at string(date-time)
      • updated_at string(date-time)
  • 401 application/json

    Unauthorized

    Hide response attributes Show response attributes object
    • error string

      401: Invalid Credentials

      404: Resource not found

      422: Unprocessable Entity

    • details string

      404: empty

      401: The credentials presented are not valid to access this resource
GET /brands 
curl \
 --request GET 'https://app.getfoundation.com/api/external/v1/brands' \
 --header "X-API-Key: $API_KEY"
Response examples (200) 
{
  "pagination": {
    "current": 42,
    "previous": 42,
    "next": 42,
    "limit": 42,
    "total_pages": 42,
    "total_count": 42
  },
  "data": [
    {
      "id": "9aa62446-c3b0-42f5-8027-3648daed9d73",
      "handle": "acme-corp",
      "title": "Acme Corp",
      "description": "string",
      "logo": "https://acme-corp.com/logo.png",
      "created_at": "2025-05-04T09:42:00Z",
      "updated_at": "2025-05-04T09:42:00Z"
    }
  ]
}
Response examples (401) 
{
  "error": "string",
  "details": "string"
}