GroupingTypes

Operations for GroupingTypes

List groupingTypes

get

List groupingTypes

Authorizations

bearerToken

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

/groupingTypes

HTTPcURLJavaScriptPython

GET /groupingTypes HTTP/1.1
Accept: */*

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

Get GroupingType

get

Get a single GroupingType by ID

Authorizations

bearerToken

Path parameters

idstringRequired

GroupingType ID

Responses

200

Successful response

application/json

401

Unauthorized

application/json

404

Not found

application/json

500

Internal server error

application/json

get

/groupingTypes/{id}

HTTPcURLJavaScriptPython

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

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

List GroupingType creation proposals

get

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

Authorizations

bearerToken

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

/createGroupingTypes

HTTPcURLJavaScriptPython

GET /createGroupingTypes HTTP/1.1
Accept: */*

{
  "data": [
    {
      "activePeriod": "[2023-01-01,2023-12-31)",
      "code": "text",
      "customValues": {
        "department": "Engineering",
        "employeeId": "EMP-12345",
        "location": "Amsterdam"
      },
      "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"
    }
  ],
  "pagination": {
    "hasMore": true,
    "limit": 1,
    "nextCursor": "text",
    "total": 1
  }
}

Propose creation of GroupingTypes

post

Create new proposals to add GroupingType 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

bearerToken

Bodyobject[]

application/json

activePeriodstringRequired

Date range in PostgreSQL format [start,end)

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

codestringRequired

repositoryIDstring · uuidRequired

Responses

201

Created successfully

application/json

400

Bad request

application/json

401

Unauthorized

application/json

500

Internal server error

application/json

post

/createGroupingTypes

HTTPcURLJavaScriptPython

POST /createGroupingTypes HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 264

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

[
  {
    "activePeriod": "[2023-01-01,2023-12-31)",
    "code": "text",
    "customValues": {
      "department": "Engineering",
      "employeeId": "EMP-12345",
      "location": "Amsterdam"
    },
    "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"
  }
]

Get GroupingType creation proposal

get

Get details of a specific GroupingType creation proposal by ID

Authorizations

bearerToken

Path parameters

idstringRequired

CreateGroupingTypeProposal ID

Responses

200

Successful response

application/json

401

Unauthorized

application/json

404

Not found

application/json

500

Internal server error

application/json

get

/createGroupingTypes/{id}

HTTPcURLJavaScriptPython

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

{
  "activePeriod": "[2023-01-01,2023-12-31)",
  "code": "text",
  "customValues": {
    "department": "Engineering",
    "employeeId": "EMP-12345",
    "location": "Amsterdam"
  },
  "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"
}

List GroupingType deletion proposals

get

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

Authorizations

bearerToken

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

/deleteGroupingTypes

HTTPcURLJavaScriptPython

GET /deleteGroupingTypes 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 GroupingTypes

post

Create new proposals to delete GroupingType 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

bearerToken

Bodyobject[]

application/json

idstring · uuidRequired

repositoryIDstring · uuidRequired

Responses

201

Created successfully

application/json

400

Bad request

application/json

401

Unauthorized

application/json

500

Internal server error

application/json

post

/deleteGroupingTypes

HTTPcURLJavaScriptPython

POST /deleteGroupingTypes 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 GroupingType deletion proposal

get

Get details of a specific GroupingType deletion proposal by ID

Authorizations

bearerToken

Path parameters

idstringRequired

DeleteGroupingTypeProposal ID

Responses

200

Successful response

application/json

401

Unauthorized

application/json

404

Not found

application/json

500

Internal server error

application/json

get

/deleteGroupingTypes/{id}

HTTPcURLJavaScriptPython

GET /deleteGroupingTypes/{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 GroupingType update proposals

get

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

Authorizations

bearerToken

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

/updateGroupingTypes

HTTPcURLJavaScriptPython

GET /updateGroupingTypes HTTP/1.1
Accept: */*

{
  "data": [
    {
      "activePeriod": "[2023-01-01,2023-12-31)",
      "code": "text",
      "customValues": {
        "department": "Engineering",
        "employeeId": "EMP-12345",
        "location": "Amsterdam"
      },
      "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"
    }
  ],
  "pagination": {
    "hasMore": true,
    "limit": 1,
    "nextCursor": "text",
    "total": 1
  }
}

Propose update of GroupingTypes

post

Create new proposals to update GroupingType 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

bearerToken

Bodyobject[]

application/json

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

idstring · uuidRequired

repositoryIDstring · uuidRequired

Responses

201

Created successfully

application/json

400

Bad request

application/json

401

Unauthorized

application/json

500

Internal server error

application/json

post

/updateGroupingTypes

HTTPcURLJavaScriptPython

POST /updateGroupingTypes HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 308

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

[
  {
    "activePeriod": "[2023-01-01,2023-12-31)",
    "code": "text",
    "customValues": {
      "department": "Engineering",
      "employeeId": "EMP-12345",
      "location": "Amsterdam"
    },
    "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"
  }
]

Get GroupingType update proposal

get

Get details of a specific GroupingType update proposal by ID

Authorizations

bearerToken

Path parameters

idstringRequired

UpdateGroupingTypeProposal ID

Responses

200

Successful response

application/json

401

Unauthorized

application/json

404

Not found

application/json

500

Internal server error

application/json

get

/updateGroupingTypes/{id}

HTTPcURLJavaScriptPython

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

{
  "activePeriod": "[2023-01-01,2023-12-31)",
  "code": "text",
  "customValues": {
    "department": "Engineering",
    "employeeId": "EMP-12345",
    "location": "Amsterdam"
  },
  "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"
}