List Category

List all (or one) categories.

Endpoint URL

https://{{base_url}}/api/v2/category

Authentication and rate limits

ItemDetails
Authentication methodOAuth 2.0 Bearer token
Rate limitRate Limit

Requests Example

curl --request GET \
  --url "https://{{base_url}}/api/v2/category/?company=1" \
  --header "Authorization: Bearer $BEARER_TOKEN"
curl --request GET \
  --url "https://{{base_url}}/api/v2/category/{id}/?company=1" \
  --header "Authorization: Bearer $BEARER_TOKEN"

Query Parameters

  • company (integer) --

    [REQUIRED]
    The ID of the specific company your API is calling. For accounts with only one company, the default value is 1.
    To lookup a specific company ID, see the List Company API.

  • id (integer) --

    Optional if you want to list a category ID. The id parameter is passed as part of the request url /category/$id/.

Response Syntax

{
  "id": integer,
  "category": "string",
  "subcategories": ["string",...]
}
Language
Click Try It! to start a request and see the response here!