v1
latestOpenAPI 3.0.12026-07-24256962.9 KBCategories
Retrieve a paginated list of Categories by query parameter(s)
get/categories
Headers
Trace-Idstring
A valid UUID (V4) for tracing requests. Will be returned as a header. If not present or invalid, a generated UUID will be returned.
End-User-Agentstring
A string representing the User Agent of the end user. Recommended for compliance. Required only when the request is not coming from the end user's browser.
End-User-Ipstring
The IP address of the end user. Recommended for compliance.
End-User-OSstring
The Operating System of the end user. Recommended for compliance.
End-User-Device-Idstring
A unique identifier for the end user's device. Recommended for compliance.
End-User-Device-Manufacturerstring
The manufacturer of the device used by the end user. Recommended for compliance.
End-User-Device-Modelstring
The device model used by the end user. Recommended for compliance.
Response
A list of Categories
Example response
{
"data": [
{
"id": "d7a2beba-0c2c-42de-9690-26f00ba08339",
"displayName": "General Inventory"
}
],
"pagination": {
"limit": 20,
"total": 1
}
}