Get Category

Retrieve a category by the category ID.

GET /v1/categories/{categoryId}

Get Category

cURL

curl --request GET \
  --url https://{cluster}.voucherify.io/v1/categories/{categoryId} \
  --header 'X-App-Id: <api-key>' \
  --header 'X-App-Token: <api-key>'

200

{
  "id": "cat_0b5f49fb31c3bf6ab0",
  "name": "Sixth",
  "hierarchy": 6,
  "created_at": "2022-07-13T06:21:36.852Z",
  "object": "category"
}

Authorizations

X-App-Id & X-App-TokenX-Voucherify-OAuth

X-App-Id · string · header · required

X-App-Token · string · header · required

Path Parameters

categoryId · string · required

Unique category ID assigned by Voucherify.

Example:

"cat_0bb81a481615a37b5e"

Response

200 - application/json

Returns a category object.

Response body schema for GET v1/categories/{categoryId}.

id · string · required

Unique category ID assigned by Voucherify.

name · string · required

Category name.

hierarchy · integer · required

Category hierarchy. Categories with lower hierarchy are processed before categories with higher hierarchy value.

Required range: x >= 0

object · enum<string> · default: category · required

The type of the object represented by the JSON. This object stores information about the category.

Available options: category

created_at · string<date-time> · required

Timestamp representing the date and time when the category was created. The value is shown in the ISO 8601 format.

Example:

"2022-07-14T10:45:13.156Z"

updated_at · string<date-time>

Timestamp representing the date and time when the category was updated. The value is shown in the ISO 8601 format.

Example:

"2022-08-16T10:52:08.094Z"