• Groups
  • getGet groups.
  • postCreate group.
  • getGet group.
  • putUpdate a group.
  • postAssign users to group.
  • postUnassign users from group.

API docs by Redocly

Absorb Integration API (v2)

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

US

https://rest.myabsorb.com/groups

CA

https://rest.myabsorb.ca/groups

EU

https://rest.myabsorb.eu/groups

AU

https://rest.myabsorb.com.au/groups

Response samples

• 200
• 422

Content type

application/json

{

• "totalItems": 0,
• "returnedItems": 0,
• "limit": 0,
• "offset": 0,
• "groups": [

  • {

    • "id": "string",
    • "name": "string",
    • "isAutomatic": true,
    • "userIds": [

      • "string"

      ],
    • "dateEdited": "2019-08-24T14:15:22Z",
    • "dateAdded": "2019-08-24T14:15:22Z"

    }

  ]

}

Create group.

Authorizations:

api_key

header Parameters

x-api-key	string
x-api-version	string 2

Request Body schema: application/json

The request to create the group.

name required	string non-empty The name of the group.
externalId	string The external ID of the group.
scopedDepartmentId	string <guid> The ID of the department the group is scoped to.

Responses

Response Schema: application/json

id	string <guid> Group identifier.
name	string The name of the group.
externalId	string The external ID of the group.
scopedDepartmentId	string <guid> The ID of the department the group is scoped to.
isAutomatic	boolean Whether the associate users are added automatically.
dateAdded	string <date-time> The date the group was added.
dateEdited	string <date-time> The group's last edited date.

US

https://rest.myabsorb.com/groups

CA

https://rest.myabsorb.ca/groups

EU

https://rest.myabsorb.eu/groups

AU

https://rest.myabsorb.com.au/groups

Request samples

• Payload

Content type

application/json

{

• "name": "string",
• "externalId": "string",
• "scopedDepartmentId": "string"

}

Response samples

• 201
• 403
• 404
• 422

Content type

application/json

{

• "id": "string",
• "name": "string",
• "externalId": "string",
• "scopedDepartmentId": "string",
• "isAutomatic": true,
• "dateAdded": "2019-08-24T14:15:22Z",
• "dateEdited": "2019-08-24T14:15:22Z"

}

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 2

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.

US

https://rest.myabsorb.com/groups/{id}

CA

https://rest.myabsorb.ca/groups/{id}

EU

https://rest.myabsorb.eu/groups/{id}

AU

https://rest.myabsorb.com.au/groups/{id}

Response samples

• 200
• 404

Content type

application/json

{

• "id": "string",
• "name": "string",
• "isAutomatic": true,
• "userIds": [

  • "string"

  ],
• "dateEdited": "2019-08-24T14:15:22Z",
• "dateAdded": "2019-08-24T14:15:22Z"

}

Update a group.

Authorizations:

api_key

path Parameters

id required

string <guid> The group identifier.

header Parameters

x-api-key	string
x-api-version	string 2

Request Body schema: application/json

The request to update a group.

name	string The group's name.
externalId	string The group's external ID.
scopedDepartmentId	string <guid> The group's scoped department ID.

Responses

Response Schema: application/json

id	string <guid> The group ID.
name	string The group name.
externalId	string The group external ID.
scopedDepartmentId	string <guid> The group's scoped department ID.
isAutomatic	boolean Whether user assignment is automatic or not.
dateAdded	string <date-time> The date added.
dateEdited	string <date-time> The date edited.

US

https://rest.myabsorb.com/groups/{id}

CA

https://rest.myabsorb.ca/groups/{id}

EU

https://rest.myabsorb.eu/groups/{id}

AU

https://rest.myabsorb.com.au/groups/{id}

Request samples

• Payload

Content type

application/json

{

• "name": "string",
• "externalId": "string",
• "scopedDepartmentId": "string"

}

Response samples

• 200
• 400
• 403
• 404
• 422

Content type

application/json

{

• "id": "string",
• "name": "string",
• "externalId": "string",
• "scopedDepartmentId": "string",
• "isAutomatic": true,
• "dateAdded": "2019-08-24T14:15:22Z",
• "dateEdited": "2019-08-24T14:15:22Z"

}

Assign users to group.

Authorizations:

api_key

path Parameters

id required

string <guid> The ID of the group.

header Parameters

x-api-key	string
x-api-version	string 2

Request Body schema: application/json

The request to assign users to the group.

userIds required

Array of strings <guid> [ items <guid > ] The IDs of the users to assign to the group.

Responses

Response Schema: application/json

string <binary>

US

https://rest.myabsorb.com/groups/{id}/users/assign

CA

https://rest.myabsorb.ca/groups/{id}/users/assign

EU

https://rest.myabsorb.eu/groups/{id}/users/assign

AU

https://rest.myabsorb.com.au/groups/{id}/users/assign

Request samples

• Payload

Content type

application/json

{

• "userIds": [

  • "string"

  ]

}

Response samples

• 200
• 400
• 403
• 404
• 422

Content type

application/json

"string"

Unassign users from group.

Authorizations:

api_key

path Parameters

id required

string <guid> The group ID to unassign users from.

header Parameters

x-api-key	string
x-api-version	string 2

Request Body schema: application/json

The request to create the group.

userIds required

Array of strings <guid> [ items <guid > ] The IDs of the users to unassign from the group.

Responses

US

https://rest.myabsorb.com/groups/{id}/users/unassign

CA

https://rest.myabsorb.ca/groups/{id}/users/unassign

EU

https://rest.myabsorb.eu/groups/{id}/users/unassign

AU

https://rest.myabsorb.com.au/groups/{id}/users/unassign

Request samples

• Payload

Content type

application/json

{

• "userIds": [

  • "string"

  ]

}

Response samples

• 403
• 404
• 422

Content type

application/json

{

• "validations": [

  • "string"

  ],
• "code": 0,
• "message": "string",
• "term": "string",
• "_meta": {

  • "property1": "string",
  • "property2": "string"

  }

}