List Categories

GET 
/v1/categories

List Categories

Request

Responses

200

Successfully retrieved a list of Categories

application/json

Schema

Schema

data object[]
Array [
id string
name string
imageUrl stringnullable
createdAt date-time
]
totalResults integer
pageSize integer
_links object
current string
next string
prev string
object string

Example (from schema)

{
  "data": [
    {
      "id": "category_xxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
      "name": "Environmental",
      "imageUrl": "categories/3.png",
      "createdAt": "2020-10-13T17:46:54.000Z"
    }
  ],
  "totalResults": 33,
  "pageSize": 25,
  "_links": {
    "current": "https://.../v1/...?cursor=eyJ2Ijox...N3AifQ%3D%3D",
    "next": "https://.../v1/...?cursor=eyJ2Ijox...N3AifQ%3D%3D",
    "prev": "https://.../v1/...?cursor=eyJ2Ijox...N3AifQ%3D%3D"
  },
  "object": "Category"
}

400

Bad request

application/json

Schema

Schema

error object
code string
title string
message string
reasons string[]nullable

Example (from schema)

{
  "error": {
    "code": "string",
    "title": "string",
    "message": "string",
    "reasons": [
      "string"
    ]
  }
}

IncorrectParams

400 Incorrect Parameters

{
  "error": {
    "code": "bad_request",
    "title": "Bad request",
    "message": "One or more of the inputs were invalid",
    "reasons": [
      "pageSize must be greater than or equal to 0"
    ]
  }
}

CursorError

Error in cursor parameter

{
  "error": {
    "code": "pagination/cursor_error",
    "title": "Bad request",
    "message": "Unable to find the next page"
  }
}

401

Unauthorized

Loading...