Skip to main content
Version: v1
API docs by Redocly

Absorb Integration API (v1)

Download OpenAPI specification:Download

Groups

Get groups.

UserIds returns a max of 50,000. A default Id ("00000000-0000-0000-0000-000000000000") will be appended to the end of the list to indicate there are more than 50,000 UserIds.

Authorizations:
api_key
query Parameters
limit
string

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

offset
string

(Deprecated) The number of pages to offset into the collection.

_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
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 (GroupResource)

Response samples

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

Get group.

UserIds returns a max of 50,000. A default Id ("00000000-0000-0000-0000-000000000000") will be appended to the end of the list to indicate there are more than 50,000 UserIds.

Authorizations:
api_key
path Parameters
id
required
string <guid>

The ID of the group.

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

1

Responses

Response Schema: application/json
id
string <guid>

Group identifier.

name
string

The name of the group.

isAutomatic
boolean

Whether the associate users are added automatically.

userIds
Array of strings <guid> [ items <guid > ]

The user identifiers of associate users. Returns a max of 50,000. Presence of default Id ("00000000-0000-0000-0000-000000000000") at the end will indicate there are more than 50,000 UserIds.

dateEdited
string <date-time>

The group's last edited date.

dateAdded
string <date-time>

The date the group was added.

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "isAutomatic": true,
  • "userIds": [
    ],
  • "dateEdited": "2019-08-24T14:15:22Z",
  • "dateAdded": "2019-08-24T14:15:22Z"
}