The Apiera REST API provides programmatic access to the Apiera platform, enabling seamless integration with your existing systems and workflows.
Apiera REST API (1.1.0)
- Mock serverhttps://docs.apiera.io/_mock/openapi/v1/categories
- Productionhttps://api.apiera.io/v1/categories
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
'https://docs.apiera.io/_mock/openapi/v1/categories?uuids%5Beq%5D=497f6eca-6276-4993-bfeb-53cbbbba6f08&parentUuids%5Beq%5D=497f6eca-6276-4993-bfeb-53cbbbba6f08&codes%5Beq%5D=string&code%5Bcontains%5D=string&code%5Bstarts%5D=string&code%5Bends%5D=string&code%5Border%5D=string&displayNames%5Beq%5D=string&displayName%5Bcontains%5D=string&displayName%5Bstarts%5D=string&displayName%5Bends%5D=string&displayName%5Border%5D=string&statuses%5Beq%5D=draft&status%5Border%5D=string&createdAt%5Beq%5D=2025-11-23T14%3A15%3A22.123456Z&createdAt%5Bmin%5D=2025-11-23T14%3A15%3A22.123456Z&createdAt%5Bmax%5D=2025-11-23T14%3A15%3A22.123456Z&createdAt%5Border%5D=string&updatedAt%5Beq%5D=2025-11-23T14%3A15%3A22.123456Z&updatedAt%5Bmin%5D=2025-11-23T14%3A15%3A22.123456Z&updatedAt%5Bmax%5D=2025-11-23T14%3A15%3A22.123456Z&updatedAt%5Border%5D=string&isRemoved%5Beq%5D=true&page=0&size=0&include%5Bcontents%5D=true&expand%5Bcontents%5D=true' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>'A paginated list of categories.
Unique identifier of the parent category. Null for root categories.
Timestamp when this category was created.
Timestamp when this category was last modified.
Timestamp when this category was removed. Null if not removed.
Lifecycle status of a category.
| Enum Value | Description |
|---|---|
| draft | The initial state of the category. |
| published | The category is visible to consumers. |
| unpublished | The category is no longer visible to consumers. |
| removed | The category has been soft-deleted. |
List of content UUIDs associated with this category. Only populated when include[contents]=true.
{ "items": [ { … } ], "pagination": { "page": 0, "size": 0, "totalItems": 0, "totalPages": 0 } }
- Mock serverhttps://docs.apiera.io/_mock/openapi/v1/categories
- Productionhttps://api.apiera.io/v1/categories
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X POST \
https://docs.apiera.io/_mock/openapi/v1/categories \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json' \
-d '{
"parentUuid": "a234027b-494b-4285-a8ce-894cd0943051",
"code": "string",
"displayName": "string"
}'The created category.
Identifier of the parent category for hierarchical organization. Null if this is a root category.
Timestamp when this category was created.
Timestamp when this category was last modified.
Timestamp when this category was removed. Null if not removed.
Lifecycle status of a category.
| Enum Value | Description |
|---|---|
| draft | The initial state of the category. |
| published | The category is visible to consumers. |
| unpublished | The category is no longer visible to consumers. |
| removed | The category has been soft-deleted. |
{ "uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "createdAt": "2025-01-15T10:30:00.000000Z", "updatedAt": "2025-01-15T10:30:00.000000Z", "status": "draft", "code": "electronics", "displayName": "Electronics" }
Request
Creates multiple categories in a single operation. All categories are created in draft status.
- Mock serverhttps://docs.apiera.io/_mock/openapi/v1/categories/bulk
- Productionhttps://api.apiera.io/v1/categories/bulk
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X POST \
https://docs.apiera.io/_mock/openapi/v1/categories/bulk \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json' \
-d '[
{
"parentUuid": "a234027b-494b-4285-a8ce-894cd0943051",
"code": "string",
"displayName": "string"
}
]'The created categories.
Identifier of the parent category for hierarchical organization. Null if this is a root category.
Timestamp when this category was created.
Timestamp when this category was last modified.
Timestamp when this category was removed. Null if not removed.
Lifecycle status of a category.
| Enum Value | Description |
|---|---|
| draft | The initial state of the category. |
| published | The category is visible to consumers. |
| unpublished | The category is no longer visible to consumers. |
| removed | The category has been soft-deleted. |
[ { "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f", "parentUuid": "a234027b-494b-4285-a8ce-894cd0943051", "createdAt": "2025-11-23T14:15:22.123456Z", "updatedAt": "2025-11-23T14:15:22.123456Z", "removedAt": "2025-11-23T14:15:22.123456Z", "status": "draft", "code": "string", "displayName": "string" } ]
- Mock serverhttps://docs.apiera.io/_mock/openapi/v1/categories/bulk
- Productionhttps://api.apiera.io/v1/categories/bulk
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X PATCH \
https://docs.apiera.io/_mock/openapi/v1/categories/bulk \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json' \
-d '[
{
"uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
"parentUuid": "a234027b-494b-4285-a8ce-894cd0943051",
"code": "string",
"displayName": "string"
}
]'The updated categories.
Identifier of the parent category for hierarchical organization. Null if this is a root category.
Timestamp when this category was created.
Timestamp when this category was last modified.
Timestamp when this category was removed. Null if not removed.
Lifecycle status of a category.
| Enum Value | Description |
|---|---|
| draft | The initial state of the category. |
| published | The category is visible to consumers. |
| unpublished | The category is no longer visible to consumers. |
| removed | The category has been soft-deleted. |
[ { "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f", "parentUuid": "a234027b-494b-4285-a8ce-894cd0943051", "createdAt": "2025-11-23T14:15:22.123456Z", "updatedAt": "2025-11-23T14:15:22.123456Z", "removedAt": "2025-11-23T14:15:22.123456Z", "status": "draft", "code": "string", "displayName": "string" } ]
- Mock serverhttps://docs.apiera.io/_mock/openapi/v1/categories/{categoryUuid}
- Productionhttps://api.apiera.io/v1/categories/{categoryUuid}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
'https://docs.apiera.io/_mock/openapi/v1/categories/{categoryUuid}?include%5Bcontents%5D=true&expand%5Bcontents%5D=true' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>'The requested category.
Timestamp when this category was created.
Timestamp when this category was last modified.
Timestamp when this category was removed. Null if not removed.
Lifecycle status of a category.
| Enum Value | Description |
|---|---|
| draft | The initial state of the category. |
| published | The category is visible to consumers. |
| unpublished | The category is no longer visible to consumers. |
| removed | The category has been soft-deleted. |
List of content UUIDs associated with this category. Only populated when include[contents]=true.
{ "uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "createdAt": "2025-01-15T10:30:00.000000Z", "updatedAt": "2025-01-15T10:30:00.000000Z", "status": "draft", "code": "electronics", "displayName": "Electronics" }
Updated parent category UUID. Set to null to remove parent relationship.
- Mock serverhttps://docs.apiera.io/_mock/openapi/v1/categories/{categoryUuid}
- Productionhttps://api.apiera.io/v1/categories/{categoryUuid}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X PATCH \
'https://docs.apiera.io/_mock/openapi/v1/categories/{categoryUuid}' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json' \
-d '{
"parentUuid": "a234027b-494b-4285-a8ce-894cd0943051",
"code": "string",
"displayName": "string"
}'The updated category.
Identifier of the parent category for hierarchical organization. Null if this is a root category.
Timestamp when this category was created.
Timestamp when this category was last modified.
Timestamp when this category was removed. Null if not removed.
Lifecycle status of a category.
| Enum Value | Description |
|---|---|
| draft | The initial state of the category. |
| published | The category is visible to consumers. |
| unpublished | The category is no longer visible to consumers. |
| removed | The category has been soft-deleted. |
{ "uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "createdAt": "2025-01-15T10:30:00.000000Z", "updatedAt": "2025-01-15T10:30:00.000000Z", "status": "draft", "code": "electronics", "displayName": "Electronics" }
- Mock serverhttps://docs.apiera.io/_mock/openapi/v1/categories/{categoryUuid}
- Productionhttps://api.apiera.io/v1/categories/{categoryUuid}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X DELETE \
'https://docs.apiera.io/_mock/openapi/v1/categories/{categoryUuid}' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>'- Mock serverhttps://docs.apiera.io/_mock/openapi/v1/categories/{categoryUuid}/actions/lifecycle
- Productionhttps://api.apiera.io/v1/categories/{categoryUuid}/actions/lifecycle
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X PATCH \
'https://docs.apiera.io/_mock/openapi/v1/categories/{categoryUuid}/actions/lifecycle' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json' \
-d '{
"transition": "remove"
}'The category after the lifecycle transition.
Identifier of the parent category for hierarchical organization. Null if this is a root category.
Timestamp when this category was created.
Timestamp when this category was last modified.
Timestamp when this category was removed. Null if not removed.
Lifecycle status of a category.
| Enum Value | Description |
|---|---|
| draft | The initial state of the category. |
| published | The category is visible to consumers. |
| unpublished | The category is no longer visible to consumers. |
| removed | The category has been soft-deleted. |
{ "uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "createdAt": "2025-01-15T10:30:00.000000Z", "updatedAt": "2025-01-15T10:30:00.000000Z", "status": "published", "code": "electronics", "displayName": "Electronics" }
Lifecycle transition to apply to a category.
| Enum Value | Description |
|---|---|
| remove | Removes the category. |
| restore | Restores the category. |
| publish | Publishes the category. |
| unpublish | Unpublishes the category. |
- Mock serverhttps://docs.apiera.io/_mock/openapi/v1/categories/bulk/actions/lifecycle
- Productionhttps://api.apiera.io/v1/categories/bulk/actions/lifecycle
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X PATCH \
https://docs.apiera.io/_mock/openapi/v1/categories/bulk/actions/lifecycle \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json' \
-d '{
"transition": "remove",
"uuids": [
"497f6eca-6276-4993-bfeb-53cbbbba6f08"
]
}'The categories after the lifecycle transition.
Identifier of the parent category for hierarchical organization. Null if this is a root category.
Timestamp when this category was created.
Timestamp when this category was last modified.
Timestamp when this category was removed. Null if not removed.
Lifecycle status of a category.
| Enum Value | Description |
|---|---|
| draft | The initial state of the category. |
| published | The category is visible to consumers. |
| unpublished | The category is no longer visible to consumers. |
| removed | The category has been soft-deleted. |
[ { "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f", "parentUuid": "a234027b-494b-4285-a8ce-894cd0943051", "createdAt": "2025-11-23T14:15:22.123456Z", "updatedAt": "2025-11-23T14:15:22.123456Z", "removedAt": "2025-11-23T14:15:22.123456Z", "status": "draft", "code": "string", "displayName": "string" } ]