Groupings

Operations for Groupings

List groupings

get

List groupings

Filter Syntax:

• Filters use exact match only

• Multiple filters are combined with AND logic

• Filterable fields: typeID, definedInGroupingID

• Example: ?typeID=123e4567-e89b-12d3-a456-426614174000&definedInGroupingID=123e4567-e89b-12d3-a456-426614174000

Authorizations

Query parameters

typeIDstringOptional

Filter by typeID (exact match)

definedInGroupingIDstringOptional

Filter by definedInGroupingID (exact match)

limitinteger · min: 1 · max: 1000Optional

Maximum number of items to return (1-1000)

Default: 10

cursorstringOptional

Cursor for pagination. Use the value from the 'nextCursor' field of the previous response.

Responses

200

Successful response

application/json

400

Bad request

application/json

401

Unauthorized

application/json

500

Internal server error

application/json

get/groupings

GET /groupings HTTP/1.1
Accept: */*

{
  "data": [
    {
      "activePeriod": "[2023-01-01,2023-12-31)",
      "code": "text",
      "createdAt": "2026-01-01T00:00:00.000Z",
      "customValues": {
        "department": "Engineering",
        "employeeId": "EMP-12345",
        "location": "Amsterdam"
      },
      "definedInGroupingID": "123e4567-e89b-12d3-a456-426614174000",
      "description": {
        "en_us": "English text",
        "nl_nl": "Nederlandse tekst"
      },
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "lastModifiedAt": "2026-01-01T00:00:00.000Z",
      "name": {
        "en_us": "English text",
        "nl_nl": "Nederlandse tekst"
      },
      "repositoryID": "123e4567-e89b-12d3-a456-426614174000",
      "typeID": "123e4567-e89b-12d3-a456-426614174000"
    }
  ],
  "pagination": {
    "hasMore": true,
    "limit": 1,
    "nextCursor": "text",
    "total": 1
  }
}

Get Grouping

get

Get a single Grouping by ID

Authorizations

Path parameters

idstringRequired

Grouping ID

Responses

200

Successful response

application/json

activePeriodstringRequired

Date range in PostgreSQL format [start,end)

Example: [2023-01-01,2023-12-31)

codestringRequired

createdAtstring · date-timeRequired

definedInGroupingIDstring · uuidOptional

idstring · uuidRequired

lastModifiedAtstring · date-timeRequired

repositoryIDstring · uuidRequired

typeIDstring · uuidOptional

401

Unauthorized

application/json

404

Not found

application/json

500

Internal server error

application/json

get/groupings/{id}

GET /groupings/{id} HTTP/1.1
Accept: */*

{
  "activePeriod": "[2023-01-01,2023-12-31)",
  "code": "text",
  "createdAt": "2026-01-01T00:00:00.000Z",
  "customValues": {
    "department": "Engineering",
    "employeeId": "EMP-12345",
    "location": "Amsterdam"
  },
  "definedInGroupingID": "123e4567-e89b-12d3-a456-426614174000",
  "description": {
    "en_us": "English text",
    "nl_nl": "Nederlandse tekst"
  },
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "lastModifiedAt": "2026-01-01T00:00:00.000Z",
  "name": {
    "en_us": "English text",
    "nl_nl": "Nederlandse tekst"
  },
  "repositoryID": "123e4567-e89b-12d3-a456-426614174000",
  "typeID": "123e4567-e89b-12d3-a456-426614174000"
}

List Grouping creation proposals

get

List all createGroupings proposals. These are proposed changes to create new Grouping records that may be automatically approved or require manual approval depending on system configuration.

Filter Syntax:

• Filters use exact match only

• Multiple filters are combined with AND logic

• Filterable fields: typeID, definedInGroupingID

• Example: ?typeID=123e4567-e89b-12d3-a456-426614174000&definedInGroupingID=123e4567-e89b-12d3-a456-426614174000

Authorizations

Query parameters

typeIDstringOptional

Filter by typeID (exact match)

definedInGroupingIDstringOptional

Filter by definedInGroupingID (exact match)

limitinteger · min: 1 · max: 1000Optional

Maximum number of items to return (1-1000)

Default: 10

cursorstringOptional

Cursor for pagination. Use the value from the 'nextCursor' field of the previous response.

Responses

200

Successful response

application/json

400

Bad request

application/json

401

Unauthorized

application/json

500

Internal server error

application/json

get/createGroupings

GET /createGroupings HTTP/1.1
Accept: */*

{
  "data": [
    {
      "activePeriod": "[2023-01-01,2023-12-31)",
      "code": "text",
      "customValues": {
        "department": "Engineering",
        "employeeId": "EMP-12345",
        "location": "Amsterdam"
      },
      "definedInGroupingID": "123e4567-e89b-12d3-a456-426614174000",
      "description": {
        "en_us": "English text",
        "nl_nl": "Nederlandse tekst"
      },
      "isProposalExecutionFailed": true,
      "isProposalResolved": false,
      "name": {
        "en_us": "English text",
        "nl_nl": "Nederlandse tekst"
      },
      "proposalExecutionErrorText": "text",
      "repositoryID": "123e4567-e89b-12d3-a456-426614174000",
      "requestID": "123e4567-e89b-12d3-a456-426614174000",
      "subjectID": "123e4567-e89b-12d3-a456-426614174000",
      "typeID": "123e4567-e89b-12d3-a456-426614174000"
    }
  ],
  "pagination": {
    "hasMore": true,
    "limit": 1,
    "nextCursor": "text",
    "total": 1
  }
}

Propose creation of Groupings

post

Create new proposals to add Grouping records. The proposals may be automatically approved or require manual approval depending on system configuration. You can submit multiple proposals in a single request.

Authorizations

Bodyobject · CreateCreateGroupingProposalRequest[]

activePeriodstringRequired

Date range in PostgreSQL format [start,end)

Example: [2023-01-01,2023-12-31)

codestringRequired

definedInGroupingIDstring · uuidOptional

repositoryIDstring · uuidRequired

typeIDstring · uuidOptional

Responses

201

Created successfully

application/json

activePeriodstringRequired

Date range in PostgreSQL format [start,end)

Example: [2023-01-01,2023-12-31)

codestringRequired

definedInGroupingIDstring · uuidOptional

isProposalExecutionFailedbooleanRead-onlyRequired

isProposalResolvedbooleanRead-onlyRequiredExample: false

proposalExecutionErrorTextstringRead-onlyOptional

repositoryIDstring · uuidRequired

requestIDstring · uuidRead-onlyRequired

subjectIDstring · uuidRead-onlyRequired

typeIDstring · uuidOptional

400

Bad request

application/json

401

Unauthorized

application/json

500

Internal server error

application/json

post/createGroupings

POST /createGroupings HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 440

[
  {
    "activePeriod": "[2023-01-01,2023-12-31)",
    "code": "text",
    "customValues": {
      "department": "Engineering",
      "employeeId": "EMP-12345",
      "location": "Amsterdam"
    },
    "definedInGroupingID": "123e4567-e89b-12d3-a456-426614174000",
    "description": {
      "en_us": "English text",
      "nl_nl": "Nederlandse tekst"
    },
    "name": {
      "en_us": "English text",
      "nl_nl": "Nederlandse tekst"
    },
    "repositoryID": "123e4567-e89b-12d3-a456-426614174000",
    "typeID": "123e4567-e89b-12d3-a456-426614174000"
  }
]

[
  {
    "activePeriod": "[2023-01-01,2023-12-31)",
    "code": "text",
    "customValues": {
      "department": "Engineering",
      "employeeId": "EMP-12345",
      "location": "Amsterdam"
    },
    "definedInGroupingID": "123e4567-e89b-12d3-a456-426614174000",
    "description": {
      "en_us": "English text",
      "nl_nl": "Nederlandse tekst"
    },
    "isProposalExecutionFailed": true,
    "isProposalResolved": false,
    "name": {
      "en_us": "English text",
      "nl_nl": "Nederlandse tekst"
    },
    "proposalExecutionErrorText": "text",
    "repositoryID": "123e4567-e89b-12d3-a456-426614174000",
    "requestID": "123e4567-e89b-12d3-a456-426614174000",
    "subjectID": "123e4567-e89b-12d3-a456-426614174000",
    "typeID": "123e4567-e89b-12d3-a456-426614174000"
  }
]

Get Grouping creation proposal

get

Get details of a specific Grouping creation proposal by ID

Authorizations

Path parameters

idstringRequired

CreateGroupingProposal ID

Responses

200

Successful response

application/json

activePeriodstringRequired

Date range in PostgreSQL format [start,end)

Example: [2023-01-01,2023-12-31)

codestringRequired

definedInGroupingIDstring · uuidOptional

isProposalExecutionFailedbooleanRead-onlyRequired

isProposalResolvedbooleanRead-onlyRequiredExample: false

proposalExecutionErrorTextstringRead-onlyOptional

repositoryIDstring · uuidRequired

requestIDstring · uuidRead-onlyRequired

subjectIDstring · uuidRead-onlyRequired

typeIDstring · uuidOptional

401

Unauthorized

application/json

404

Not found

application/json

500

Internal server error

application/json

get/createGroupings/{id}

GET /createGroupings/{id} HTTP/1.1
Accept: */*

{
  "activePeriod": "[2023-01-01,2023-12-31)",
  "code": "text",
  "customValues": {
    "department": "Engineering",
    "employeeId": "EMP-12345",
    "location": "Amsterdam"
  },
  "definedInGroupingID": "123e4567-e89b-12d3-a456-426614174000",
  "description": {
    "en_us": "English text",
    "nl_nl": "Nederlandse tekst"
  },
  "isProposalExecutionFailed": true,
  "isProposalResolved": false,
  "name": {
    "en_us": "English text",
    "nl_nl": "Nederlandse tekst"
  },
  "proposalExecutionErrorText": "text",
  "repositoryID": "123e4567-e89b-12d3-a456-426614174000",
  "requestID": "123e4567-e89b-12d3-a456-426614174000",
  "subjectID": "123e4567-e89b-12d3-a456-426614174000",
  "typeID": "123e4567-e89b-12d3-a456-426614174000"
}

List Grouping deletion proposals

get

List all deleteGroupings proposals. These are proposed changes to delete Grouping records that may be automatically approved or require manual approval depending on system configuration.

Authorizations

Query parameters

limitinteger · min: 1 · max: 1000Optional

Maximum number of items to return (1-1000)

Default: 10

cursorstringOptional

Cursor for pagination. Use the value from the 'nextCursor' field of the previous response.

Responses

200

Successful response

application/json

400

Bad request

application/json

401

Unauthorized

application/json

500

Internal server error

application/json

get/deleteGroupings

GET /deleteGroupings HTTP/1.1
Accept: */*

{
  "data": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "isProposalExecutionFailed": true,
      "isProposalResolved": false,
      "proposalExecutionErrorText": "text",
      "repositoryID": "123e4567-e89b-12d3-a456-426614174000",
      "requestID": "123e4567-e89b-12d3-a456-426614174000"
    }
  ],
  "pagination": {
    "hasMore": true,
    "limit": 1,
    "nextCursor": "text",
    "total": 1
  }
}

Propose deletion of Groupings

post

Create new proposals to delete Grouping records. The proposals may be automatically approved or require manual approval depending on system configuration. You can submit multiple proposals in a single request.

Authorizations

Bodyobject · CreateDeleteGroupingProposalRequest[]

idstring · uuidRequired

repositoryIDstring · uuidRequired

Responses

201

Created successfully

application/json

idstring · uuidRequired

isProposalExecutionFailedbooleanRead-onlyRequired

isProposalResolvedbooleanRead-onlyRequiredExample: false

proposalExecutionErrorTextstringRead-onlyOptional

repositoryIDstring · uuidRequired

requestIDstring · uuidRead-onlyRequired

400

Bad request

application/json

401

Unauthorized

application/json

500

Internal server error

application/json

post/deleteGroupings

POST /deleteGroupings HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 101

[
  {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "repositoryID": "123e4567-e89b-12d3-a456-426614174000"
  }
]

[
  {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "isProposalExecutionFailed": true,
    "isProposalResolved": false,
    "proposalExecutionErrorText": "text",
    "repositoryID": "123e4567-e89b-12d3-a456-426614174000",
    "requestID": "123e4567-e89b-12d3-a456-426614174000"
  }
]

Get Grouping deletion proposal

get

Get details of a specific Grouping deletion proposal by ID

Authorizations

Path parameters

idstringRequired

DeleteGroupingProposal ID

Responses

200

Successful response

application/json

idstring · uuidRequired

isProposalExecutionFailedbooleanRead-onlyRequired

isProposalResolvedbooleanRead-onlyRequiredExample: false

proposalExecutionErrorTextstringRead-onlyOptional

repositoryIDstring · uuidRequired

requestIDstring · uuidRead-onlyRequired

401

Unauthorized

application/json

404

Not found

application/json

500

Internal server error

application/json

get/deleteGroupings/{id}

GET /deleteGroupings/{id} HTTP/1.1
Accept: */*

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "isProposalExecutionFailed": true,
  "isProposalResolved": false,
  "proposalExecutionErrorText": "text",
  "repositoryID": "123e4567-e89b-12d3-a456-426614174000",
  "requestID": "123e4567-e89b-12d3-a456-426614174000"
}

List Grouping update proposals

get

List all updateGroupings proposals. These are proposed changes to update existing Grouping records that may be automatically approved or require manual approval depending on system configuration.

Filter Syntax:

• Filters use exact match only

• Multiple filters are combined with AND logic

• Filterable fields: typeID, definedInGroupingID

• Example: ?typeID=123e4567-e89b-12d3-a456-426614174000&definedInGroupingID=123e4567-e89b-12d3-a456-426614174000

Authorizations

Query parameters

typeIDstringOptional

Filter by typeID (exact match)

definedInGroupingIDstringOptional

Filter by definedInGroupingID (exact match)

limitinteger · min: 1 · max: 1000Optional

Maximum number of items to return (1-1000)

Default: 10

cursorstringOptional

Cursor for pagination. Use the value from the 'nextCursor' field of the previous response.

Responses

200

Successful response

application/json

400

Bad request

application/json

401

Unauthorized

application/json

500

Internal server error

application/json

get/updateGroupings

GET /updateGroupings HTTP/1.1
Accept: */*

{
  "data": [
    {
      "activePeriod": "[2023-01-01,2023-12-31)",
      "code": "text",
      "customValues": {
        "department": "Engineering",
        "employeeId": "EMP-12345",
        "location": "Amsterdam"
      },
      "definedInGroupingID": "123e4567-e89b-12d3-a456-426614174000",
      "description": {
        "en_us": "English text",
        "nl_nl": "Nederlandse tekst"
      },
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "isProposalExecutionFailed": true,
      "isProposalResolved": false,
      "name": {
        "en_us": "English text",
        "nl_nl": "Nederlandse tekst"
      },
      "proposalExecutionErrorText": "text",
      "repositoryID": "123e4567-e89b-12d3-a456-426614174000",
      "requestID": "123e4567-e89b-12d3-a456-426614174000",
      "typeID": "123e4567-e89b-12d3-a456-426614174000"
    }
  ],
  "pagination": {
    "hasMore": true,
    "limit": 1,
    "nextCursor": "text",
    "total": 1
  }
}

Propose update of Groupings

post

Create new proposals to update Grouping records. All fields are optional - omitted fields will not be changed. Only include fields you want to update. Setting a field to null will clear its value (where applicable). The proposals may be automatically approved or require manual approval depending on system configuration. You can submit multiple proposals in a single request.

Authorizations

Bodyobject · CreateUpdateGroupingProposalRequest[]

activePeriodstringOptional

Date range in PostgreSQL format [start,end) (omit to keep current value)

Example: [2023-01-01,2023-12-31)

codestringOptional

Omit this field to keep current value

definedInGroupingIDstring · uuidOptional

Omit this field to keep current value

idstring · uuidRequired

repositoryIDstring · uuidRequired

typeIDstring · uuidOptional

Omit this field to keep current value

Responses

201

Created successfully

application/json

activePeriodstringOptional

Date range in PostgreSQL format [start,end)

Example: [2023-01-01,2023-12-31)

codestringOptional

definedInGroupingIDstring · uuidOptional

idstring · uuidRequired

isProposalExecutionFailedbooleanRead-onlyRequired

isProposalResolvedbooleanRead-onlyRequiredExample: false

proposalExecutionErrorTextstringRead-onlyOptional

repositoryIDstring · uuidRequired

requestIDstring · uuidRead-onlyRequired

typeIDstring · uuidOptional

400

Bad request

application/json

401

Unauthorized

application/json

500

Internal server error

application/json

post/updateGroupings

POST /updateGroupings HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 484

[
  {
    "activePeriod": "[2023-01-01,2023-12-31)",
    "code": "text",
    "customValues": {
      "department": "Engineering",
      "employeeId": "EMP-12345",
      "location": "Amsterdam"
    },
    "definedInGroupingID": "123e4567-e89b-12d3-a456-426614174000",
    "description": {
      "en_us": "English text",
      "nl_nl": "Nederlandse tekst"
    },
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "name": {
      "en_us": "English text",
      "nl_nl": "Nederlandse tekst"
    },
    "repositoryID": "123e4567-e89b-12d3-a456-426614174000",
    "typeID": "123e4567-e89b-12d3-a456-426614174000"
  }
]

[
  {
    "activePeriod": "[2023-01-01,2023-12-31)",
    "code": "text",
    "customValues": {
      "department": "Engineering",
      "employeeId": "EMP-12345",
      "location": "Amsterdam"
    },
    "definedInGroupingID": "123e4567-e89b-12d3-a456-426614174000",
    "description": {
      "en_us": "English text",
      "nl_nl": "Nederlandse tekst"
    },
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "isProposalExecutionFailed": true,
    "isProposalResolved": false,
    "name": {
      "en_us": "English text",
      "nl_nl": "Nederlandse tekst"
    },
    "proposalExecutionErrorText": "text",
    "repositoryID": "123e4567-e89b-12d3-a456-426614174000",
    "requestID": "123e4567-e89b-12d3-a456-426614174000",
    "typeID": "123e4567-e89b-12d3-a456-426614174000"
  }
]

Get Grouping update proposal

get

Get details of a specific Grouping update proposal by ID

Authorizations

Path parameters

idstringRequired

UpdateGroupingProposal ID

Responses

200

Successful response

application/json

activePeriodstringOptional

Date range in PostgreSQL format [start,end)

Example: [2023-01-01,2023-12-31)

codestringOptional

definedInGroupingIDstring · uuidOptional

idstring · uuidRequired

isProposalExecutionFailedbooleanRead-onlyRequired

isProposalResolvedbooleanRead-onlyRequiredExample: false

proposalExecutionErrorTextstringRead-onlyOptional

repositoryIDstring · uuidRequired

requestIDstring · uuidRead-onlyRequired

typeIDstring · uuidOptional

401

Unauthorized

application/json

404

Not found

application/json

500

Internal server error

application/json

get/updateGroupings/{id}

GET /updateGroupings/{id} HTTP/1.1
Accept: */*

{
  "activePeriod": "[2023-01-01,2023-12-31)",
  "code": "text",
  "customValues": {
    "department": "Engineering",
    "employeeId": "EMP-12345",
    "location": "Amsterdam"
  },
  "definedInGroupingID": "123e4567-e89b-12d3-a456-426614174000",
  "description": {
    "en_us": "English text",
    "nl_nl": "Nederlandse tekst"
  },
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "isProposalExecutionFailed": true,
  "isProposalResolved": false,
  "name": {
    "en_us": "English text",
    "nl_nl": "Nederlandse tekst"
  },
  "proposalExecutionErrorText": "text",
  "repositoryID": "123e4567-e89b-12d3-a456-426614174000",
  "requestID": "123e4567-e89b-12d3-a456-426614174000",
  "typeID": "123e4567-e89b-12d3-a456-426614174000"
}