v1

latestOpenAPI 3.1.02026-07-2498134321.1 KB

Obligations

Get All Obligation Types

Returns all obligation types. For more information, see Obligation Types.

OAuth Scope required: public.obligations.readTypes

get/obligations/types

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

idstring

The unique identifier of the obligation type

namestring

The unique key of the obligation type that corresponds to obligationTypeKey

displayNamestring

The display name of the obligation type

descriptionstring

The description of the obligation type

Example response

[
  {
    "id": "22e2ff72-56a1-4711-a4ca-41328d311e9f",
    "name": "payment",
    "displayName": "Payment Obligation",
    "description": "An obligation requiring a scheduled payment."
  }
]