Skip to main content
Version: v1
API docs by Redocly

Absorb Integration API (v1)

Download OpenAPI specification:Download

Categories

List categories.

Authorizations:
api_key
query Parameters
_filter
string

One or more filter operations to be performed on the collection. The referenced fields must allow filtering. See the respective report's schema for which fields can be filtered.

Supports most of the OData filter syntax.

Supported operations: * eq, * ne, * gt, * ge, * lt, * le, * and, * or, * not, * ()

Supported functions: * substringof('value',fieldName), * endswith(fieldName,'value'), * startswith(fieldName,'value'), * tolower(fieldName), * toupper(fieldName)

Examples:

  • _filter=firstname eq 'Jeffrey'
  • _filter=id eq guid'a14c149a-2ce0-41d4-b532-02189ad3cb22'
  • _filter=startsWith(lastname,'leb') or dateAdded ge datetime'1998-03-06T20:38:07Z'
_sort
string

Optional list of comma-separated fields to sort the collection by.

The referenced fields must allow sorting. See the respective report's schema for which fields can be sorted. If not specified, all report fields are returned.

To sort in a descending manner, prefix the field name with -. For example, _sort=name,-date, sorts the collection of items by name (ascending) and then by date (descending).

_limit
string

The maximum number of items to return in the current page of the collection.

_offset
string

The number of pages to offset into the collection.

header Parameters
x-api-key
string
x-api-version
string

1

Responses

Response Schema: application/json
Array
id
string <guid>

The unique identifier of the category.

parentId
string <guid>

Sortable Filterable

The ID of the parent category.

name
string

Sortable Filterable

The name of the category.

description
string

The description for the category.

Response samples

Content type
application/json
[
  • {
    }
]

Get category.

Authorizations:
api_key
path Parameters
id
required
string <guid>

The ID of the category.

header Parameters
x-api-key
string
x-api-version
string

1

Responses

Response Schema: application/json
id
string <guid>

The unique identifier of the category.

parentId
string <guid>

The ID of the parent category.

name
string

The name of the category.

description
string

The description for the category.

Response samples

Content type
application/json
{
  • "id": "string",
  • "parentId": "string",
  • "name": "string",
  • "description": "string"
}