Skip to main content
Version: v2
API docs by Redocly

Absorb Integration API (v2)

Download OpenAPI specification:Download

Tags

Get tag.

Authorizations:
api_key
path Parameters
id
required
string <guid>

The tag ID.

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

2

Responses

Response Schema: application/json
id
string <guid>

The unique tag identifier.

name
string

The tag's name.

Response samples

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

Update tag.

Authorizations:
api_key
path Parameters
id
required
string <guid>

The tag ID.

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

2

Request Body schema: application/json

The model for the tag data.

name
required
string [ 0 .. 255 ] characters

The tag's name.

Responses

Response Schema: application/json
id
string <guid>

The unique tag identifier.

name
string

The tag's name.

Request samples

Content type
application/json
{
  • "name": "string"
}

Response samples

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

Create tag.

Authorizations:
api_key
header Parameters
x-api-key
string
x-api-version
string

2

Request Body schema: application/json

The request to create a tag.

id
string <guid>

The unique identifier to use for the tag. If not supplied one will be created.

name
required
string [ 0 .. 255 ] characters

The tag's name.

Responses

Response Schema: application/json
id
string <guid>

The unique tag identifier.

name
string

The tag's name.

Request samples

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

Response samples

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

List tags.

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

2

Responses

Response Schema: application/json
totalItems
integer <int32>

The total number of items in the unbounded collection

returnedItems
integer <int32>

The number of items in the bound collection being returned

limit
integer <int32>

The current page size for the collection

offset
integer <int32>

The current offset for the collection

Array of objects (TagResource)

A collection of TagResources.

Response samples

Content type
application/json
{
  • "totalItems": 0,
  • "returnedItems": 0,
  • "limit": 0,
  • "offset": 0,
  • "tags": [
    ]
}