Sign in

v1

latestOpenAPI 3.1.02026-07-2498134321.1 KB
Obligations

List All Obligations

View all obligations in the company, with filtering available via query parameters.

OAuth Scope required: public.obligations.readObligations

get/obligations

Query parameters

pageinteger

The page number used when paginating through a list of results.

pageSizeinteger

A limit of the number of results to return.

filterstring

Filter obligations using a formula. The obligation property ID should be enclosed in brackets [ ] and the value should be enclosed in single quotes ' '.

Supported formula operations include the following with documentation found here:

<ul> <li>Equals / NotEqual</li> <li>Contains</li> <li>IsEmpty / IsNotEmpty</li> <li>LessThan / LessThanOrEqual</li> <li>GreaterThan / GreaterThanOrEqual</li> <li>Date / Today / RelativeDate</li> <li>And / Or</li> </ul>
searchstring

Free-text search across all obligation properties, matching the in-app search. Combined with filter and any other parameters using logical AND. Maximum 1000 characters.

sortField'name' | 'lastUpdated'

The field to sort by. Default is 'name'.

sortDirection'ASC' | 'DESC'

The direction to sort by. Default is 'DESC'.

Headers

x-as-user-emailstring
Example:jane.doe@test.com

Denotes the actor of the request. When used, the API will take into account this user's permissions and access. This or x-as-user-id is required when the associated token was produced from the Client Credentials grant or with legacy bearer tokens on select endpoints. More information about permissions.

x-as-user-idstring
Example:5f0375c4cdc1927a3c5edcd3

Denotes the actor of the request. When used, the API will take into account this user's permissions and access. This or x-as-user-email is required when the associated token was produced from the Client Credentials grant or with legacy bearer tokens on select endpoints. More information about permissions.

Response

200

pageinteger

The zero-based page number for paginating through results

pageSizeinteger

The number of items to return per page

countinteger

The total number of items available across all pages

Example response

{
  "pageSize": 20,
  "count": 42,
  "list": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "ironcladId": "OB-1",
      "name": "Obligation XYZ",
      "lastUpdated": "2021-01-01T00:00:00Z",
      "namedTypeIds": [
        "eda20988-6b99-404b-99dc-866b84b63883"
      ],
      "parentReadableId": "IC-1",
      "parentRecordName": "Parent Record"
    }
  ]
}