Get Categories

GET /categories

Api key auth

Get a paginated list of categories

Query parameters

page integer(int32)

Page Number
limit integer(int32)

Number of items per page

Responses

200 application/json

OK
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.
  
  title string
  
  parent_id string(guid)
  
  handle string
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
404 application/json

Not Found
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 /categories

curl \
 --request GET 'https://stg.getfoundation.com/api/external/v1/categories' \
 --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",
      "title": "Toys",
      "parent_id": "string",
      "handle": "toys"
    }
  ]
}

Response examples (401)

{
  "error": "string",
  "details": "string"
}

Response examples (404)

{
  "error": "string",
  "details": "string"
}