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

Path parameters

orgkeepIDstringRequired

Organization identifier

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

HTTPcURLJavaScriptPython

GET /api/orgkeep/v4/{orgkeepID}/groupings HTTP/1.1
Host: matrix.ag5.com
X-API-Key: YOUR_API_KEY
Accept: */*

{
  "data": [
    {
      "activePeriod": "[2023-01-01,2023-12-31)",
      "code": "text",
      "createdAt": "2025-07-18T20:01:45.971Z",
      "customValues": {
        "department": "Engineering",
        "employeeId": "EMP-12345",
        "location": "Amsterdam"
      },
      "definedInGroupingID": "123e4567-e89b-12d3-a456-426614174000",
      "description": {
        "en": "English text",
        "nl": "Nederlandse tekst"
      },
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "lastModifiedAt": "2025-07-18T20:01:45.971Z",
      "name": {
        "en": "English text",
        "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

orgkeepIDstringRequired

Organization identifier

idstringRequired

Grouping ID

Responses

200

Successful response

application/json

401

Unauthorized

application/json

404

Not found

application/json

500

Internal server error

application/json

get

HTTPcURLJavaScriptPython

GET /api/orgkeep/v4/{orgkeepID}/groupings/{id} HTTP/1.1
Host: matrix.ag5.com
X-API-Key: YOUR_API_KEY
Accept: */*

{
  "activePeriod": "[2023-01-01,2023-12-31)",
  "code": "text",
  "createdAt": "2025-07-18T20:01:45.971Z",
  "customValues": {
    "department": "Engineering",
    "employeeId": "EMP-12345",
    "location": "Amsterdam"
  },
  "definedInGroupingID": "123e4567-e89b-12d3-a456-426614174000",
  "description": {
    "en": "English text",
    "nl": "Nederlandse tekst"
  },
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "lastModifiedAt": "2025-07-18T20:01:45.971Z",
  "name": {
    "en": "English text",
    "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

Path parameters

orgkeepIDstringRequired

Organization identifier

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

HTTPcURLJavaScriptPython

GET /api/orgkeep/v4/{orgkeepID}/createGroupings HTTP/1.1
Host: matrix.ag5.com
X-API-Key: YOUR_API_KEY
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": "English text",
        "nl": "Nederlandse tekst"
      },
      "isProposalExecutionFailed": true,
      "isProposalResolved": true,
      "name": {
        "en": "English text",
        "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 Grouping

post

Create a new proposal to add a Grouping record. The proposal may be automatically approved or require manual approval depending on system configuration.

Authorizations

Path parameters

orgkeepIDstringRequired

Organization identifier

Body

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

400

Bad request

application/json

401

Unauthorized

application/json

500

Internal server error

application/json

post

HTTPcURLJavaScriptPython

POST /api/orgkeep/v4/{orgkeepID}/createGroupings HTTP/1.1
Host: matrix.ag5.com
X-API-Key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 426

{
  "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": "English text",
    "nl": "Nederlandse tekst"
  },
  "name": {
    "en": "English text",
    "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": "English text",
    "nl": "Nederlandse tekst"
  },
  "isProposalExecutionFailed": true,
  "isProposalResolved": true,
  "name": {
    "en": "English text",
    "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

orgkeepIDstringRequired

Organization identifier

idstringRequired

CreateGrouping ID

Responses

200

Successful response

application/json

401

Unauthorized

application/json

404

Not found

application/json

500

Internal server error

application/json

get

HTTPcURLJavaScriptPython

GET /api/orgkeep/v4/{orgkeepID}/createGroupings/{id} HTTP/1.1
Host: matrix.ag5.com
X-API-Key: YOUR_API_KEY
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": "English text",
    "nl": "Nederlandse tekst"
  },
  "isProposalExecutionFailed": true,
  "isProposalResolved": true,
  "name": {
    "en": "English text",
    "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

Path parameters

orgkeepIDstringRequired

Organization identifier

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

HTTPcURLJavaScriptPython

GET /api/orgkeep/v4/{orgkeepID}/deleteGroupings HTTP/1.1
Host: matrix.ag5.com
X-API-Key: YOUR_API_KEY
Accept: */*

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

Propose creation of Grouping

post

Create a new proposal to add a Grouping record. The proposal may be automatically approved or require manual approval depending on system configuration.

Authorizations

Path parameters

orgkeepIDstringRequired

Organization identifier

Body

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

HTTPcURLJavaScriptPython

POST /api/orgkeep/v4/{orgkeepID}/deleteGroupings HTTP/1.1
Host: matrix.ag5.com
X-API-Key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 99

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

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "isProposalExecutionFailed": true,
  "isProposalResolved": true,
  "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

orgkeepIDstringRequired

Organization identifier

idstringRequired

DeleteGrouping ID

Responses

200

Successful response

application/json

401

Unauthorized

application/json

404

Not found

application/json

500

Internal server error

application/json

get

HTTPcURLJavaScriptPython

GET /api/orgkeep/v4/{orgkeepID}/deleteGroupings/{id} HTTP/1.1
Host: matrix.ag5.com
X-API-Key: YOUR_API_KEY
Accept: */*

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "isProposalExecutionFailed": true,
  "isProposalResolved": true,
  "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

Path parameters

orgkeepIDstringRequired

Organization identifier

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

HTTPcURLJavaScriptPython

GET /api/orgkeep/v4/{orgkeepID}/updateGroupings HTTP/1.1
Host: matrix.ag5.com
X-API-Key: YOUR_API_KEY
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": "English text",
        "nl": "Nederlandse tekst"
      },
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "isProposalExecutionFailed": true,
      "isProposalResolved": true,
      "name": {
        "en": "English text",
        "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 creation of Grouping

post

Create a new proposal to add a Grouping record. The proposal may be automatically approved or require manual approval depending on system configuration.

Authorizations

Path parameters

orgkeepIDstringRequired

Organization identifier

Body

activePeriodstringRequired

Date range in PostgreSQL format [start,end)

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

codestringRequired

definedInGroupingIDstring · uuidOptional

idstring · uuidRequired

repositoryIDstring · uuidRequired

typeIDstring · uuidOptional

Responses

201

Created successfully

application/json

400

Bad request

application/json

401

Unauthorized

application/json

500

Internal server error

application/json

post

HTTPcURLJavaScriptPython

POST /api/orgkeep/v4/{orgkeepID}/updateGroupings HTTP/1.1
Host: matrix.ag5.com
X-API-Key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 470

{
  "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": "English text",
    "nl": "Nederlandse tekst"
  },
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "name": {
    "en": "English text",
    "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": "English text",
    "nl": "Nederlandse tekst"
  },
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "isProposalExecutionFailed": true,
  "isProposalResolved": true,
  "name": {
    "en": "English text",
    "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

orgkeepIDstringRequired

Organization identifier

idstringRequired

UpdateGrouping ID

Responses

200

Successful response

application/json

401

Unauthorized

application/json

404

Not found

application/json

500

Internal server error

application/json

get

HTTPcURLJavaScriptPython

GET /api/orgkeep/v4/{orgkeepID}/updateGroupings/{id} HTTP/1.1
Host: matrix.ag5.com
X-API-Key: YOUR_API_KEY
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": "English text",
    "nl": "Nederlandse tekst"
  },
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "isProposalExecutionFailed": true,
  "isProposalResolved": true,
  "name": {
    "en": "English text",
    "nl": "Nederlandse tekst"
  },
  "proposalExecutionErrorText": "text",
  "repositoryID": "123e4567-e89b-12d3-a456-426614174000",
  "requestID": "123e4567-e89b-12d3-a456-426614174000",
  "typeID": "123e4567-e89b-12d3-a456-426614174000"
}