Get a list of categories
- 05 Dec 2024
- 1 Minute to read
- Print
Get a list of categories
- Updated on 05 Dec 2024
- 1 Minute to read
- Print
Article summary
Did you find this summary helpful?
Thank you for your feedback
Get
/v{version}/Categories
Categories are implicitly filtered by the user's read permission.
Security
API Key
Header parameter nameX-ApiKey
Api Key
API Key
Header parameter nameX-Session-Id
Session Id
Path parameters
version
stringRequired
The requested API version
Default"1.18"
Query parameters
name
string
Name of the category
parentCategoryId
integer (int32)
Unique ID of the parent category
Minimum1.0
Maximum2147483647.0
rootCategoryName
string
Name of the root category
Responses
200
OK
Array of object
object
Category
Created
string (date-time)
Creation date in UTC
Id
integer (int32)
Unique ID of the category
Modified
string (date-time)
Modification date in UTC
Name
string
Name of the category
ParentId
integer (int32)
Unique ID of the parent category
Permissions
object
Permissions of the category
Read
boolean
Write
boolean
Selectable
boolean
If true, the category is selectable in the IXM Platform. Default: false.
400
Bad request
object
ValidationErrors
object
property*
Array of string additionalProperties
string
403
Access denied
object
Id
string
Message
string
Type
string
Values
object
property*
object additionalProperties
500
Unexpected error
object
Id
string
Message
string
Type
string
Values
object
property*
object additionalProperties
.png?sv=2022-11-02&spr=https&st=2025-02-06T13%3A59%3A24Z&se=2025-02-06T14%3A14%3A24Z&sr=c&sp=r&sig=7KtZ9gjBH7PM8V5PA7hV2LmZiRIkFuw66AR8NRjhKYE%3D)