TypesOfProof

Operations for TypesOfProof

List typesOfProof

get

List typesOfProof

Filter Syntax:

• Filters use exact match only

• Multiple filters are combined with AND logic

• Filterable fields: skillDefinitionID

• Example: ?skillDefinitionID=123e4567-e89b-12d3-a456-426614174000

Authorizations

Path parameters

orgkeepIDstringRequired

Organization identifier

Query parameters

skillDefinitionIDstringOptional

Filter by skillDefinitionID (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}/typesOfProof 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.684Z",
      "customValues": {
        "department": "Engineering",
        "employeeId": "EMP-12345",
        "location": "Amsterdam"
      },
      "description": "text",
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "lastModifiedAt": "2025-07-18T20:01:45.684Z",
      "name": {
        "en": "English text",
        "nl": "Nederlandse tekst"
      },
      "repositoryID": "123e4567-e89b-12d3-a456-426614174000",
      "skillDefinitionID": "123e4567-e89b-12d3-a456-426614174000"
    }
  ],
  "pagination": {
    "hasMore": true,
    "limit": 1,
    "nextCursor": "text",
    "total": 1
  }
}

Get TypesOfProof

get

Get a single typesOfProof by ID

Authorizations

Path parameters

orgkeepIDstringRequired

Organization identifier

idstringRequired

TypesOfProof 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}/typesOfProof/{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.684Z",
  "customValues": {
    "department": "Engineering",
    "employeeId": "EMP-12345",
    "location": "Amsterdam"
  },
  "description": "text",
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "lastModifiedAt": "2025-07-18T20:01:45.684Z",
  "name": {
    "en": "English text",
    "nl": "Nederlandse tekst"
  },
  "repositoryID": "123e4567-e89b-12d3-a456-426614174000",
  "skillDefinitionID": "123e4567-e89b-12d3-a456-426614174000"
}

List TypesOfProof creation proposals

get

List all createTypesOfProof proposals. These are proposed changes to create new TypesOfProof 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: skillDefinitionID

• Example: ?skillDefinitionID=123e4567-e89b-12d3-a456-426614174000

Authorizations

Path parameters

orgkeepIDstringRequired

Organization identifier

Query parameters

skillDefinitionIDstringOptional

Filter by skillDefinitionID (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}/createTypesOfProof 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"
      },
      "description": "text",
      "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",
      "skillDefinitionID": "123e4567-e89b-12d3-a456-426614174000",
      "subjectID": "123e4567-e89b-12d3-a456-426614174000"
    }
  ],
  "pagination": {
    "hasMore": true,
    "limit": 1,
    "nextCursor": "text",
    "total": 1
  }
}

Propose creation of TypesOfProof

post

Create a new proposal to add a TypesOfProof 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)

codestringOptional

descriptionstringOptional

repositoryIDstring · uuidRequired

skillDefinitionIDstring · 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}/createTypesOfProof HTTP/1.1
Host: matrix.ag5.com
X-API-Key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 336

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

{
  "activePeriod": "[2023-01-01,2023-12-31)",
  "code": "text",
  "customValues": {
    "department": "Engineering",
    "employeeId": "EMP-12345",
    "location": "Amsterdam"
  },
  "description": "text",
  "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",
  "skillDefinitionID": "123e4567-e89b-12d3-a456-426614174000",
  "subjectID": "123e4567-e89b-12d3-a456-426614174000"
}

Get TypesOfProof creation proposal

get

Get details of a specific TypesOfProof creation proposal by ID

Authorizations

Path parameters

orgkeepIDstringRequired

Organization identifier

idstringRequired

CreateTypesOfProof 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}/createTypesOfProof/{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"
  },
  "description": "text",
  "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",
  "skillDefinitionID": "123e4567-e89b-12d3-a456-426614174000",
  "subjectID": "123e4567-e89b-12d3-a456-426614174000"
}

List TypesOfProof deletion proposals

get

List all deleteTypesOfProof proposals. These are proposed changes to delete TypesOfProof 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}/deleteTypesOfProof 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 TypesOfProof

post

Create a new proposal to add a TypesOfProof 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}/deleteTypesOfProof 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 TypesOfProof deletion proposal

get

Get details of a specific TypesOfProof deletion proposal by ID

Authorizations

Path parameters

orgkeepIDstringRequired

Organization identifier

idstringRequired

DeleteTypesOfProof 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}/deleteTypesOfProof/{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 TypesOfProof update proposals

get

List all updateTypesOfProof proposals. These are proposed changes to update existing TypesOfProof 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: skillDefinitionID

• Example: ?skillDefinitionID=123e4567-e89b-12d3-a456-426614174000

Authorizations

Path parameters

orgkeepIDstringRequired

Organization identifier

Query parameters

skillDefinitionIDstringOptional

Filter by skillDefinitionID (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}/updateTypesOfProof 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"
      },
      "description": "text",
      "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",
      "skillDefinitionID": "123e4567-e89b-12d3-a456-426614174000"
    }
  ],
  "pagination": {
    "hasMore": true,
    "limit": 1,
    "nextCursor": "text",
    "total": 1
  }
}

Propose creation of TypesOfProof

post

Create a new proposal to add a TypesOfProof 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)

codestringOptional

descriptionstringOptional

idstring · uuidRequired

repositoryIDstring · uuidRequired

skillDefinitionIDstring · 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}/updateTypesOfProof HTTP/1.1
Host: matrix.ag5.com
X-API-Key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 380

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

{
  "activePeriod": "[2023-01-01,2023-12-31)",
  "code": "text",
  "customValues": {
    "department": "Engineering",
    "employeeId": "EMP-12345",
    "location": "Amsterdam"
  },
  "description": "text",
  "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",
  "skillDefinitionID": "123e4567-e89b-12d3-a456-426614174000"
}

Get TypesOfProof update proposal

get

Get details of a specific TypesOfProof update proposal by ID

Authorizations

Path parameters

orgkeepIDstringRequired

Organization identifier

idstringRequired

UpdateTypesOfProof 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}/updateTypesOfProof/{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"
  },
  "description": "text",
  "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",
  "skillDefinitionID": "123e4567-e89b-12d3-a456-426614174000"
}