EntityDefinitions

Operations for EntityDefinitions

List entityDefinitions

get

List entityDefinitions

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}/entityDefinitions HTTP/1.1
Host: matrix.ag5.com
X-API-Key: YOUR_API_KEY
Accept: */*

{
  "data": [
    {
      "code": "text",
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": {
        "en": "English text",
        "nl": "Nederlandse tekst"
      }
    }
  ],
  "pagination": {
    "hasMore": true,
    "limit": 1,
    "nextCursor": "text",
    "total": 1
  }
}

Get EntityDefinition

get

Get a single entityDefinition by ID

Authorizations

Path parameters

orgkeepIDstringRequired

Organization identifier

idstringRequired

EntityDefinition 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}/entityDefinitions/{id} HTTP/1.1
Host: matrix.ag5.com
X-API-Key: YOUR_API_KEY
Accept: */*

{
  "code": "text",
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "name": {
    "en": "English text",
    "nl": "Nederlandse tekst"
  }
}