CustomFieldDefinitions

Operations for CustomFieldDefinitions

List customFieldDefinitions

get

List customFieldDefinitions

Filter Syntax:

• Filters use exact match only

• Multiple filters are combined with AND logic

• Filterable fields: entityDefinitionID

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

Authorizations

Query parameters

entityDefinitionIDstringOptional

Filter by entityDefinitionID (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/customFieldDefinitions

GET /customFieldDefinitions HTTP/1.1
Accept: */*

{
  "data": [
    {
      "code": "text",
      "createdAt": "2026-01-01T00:00:00.000Z",
      "entityDefinitionID": "123e4567-e89b-12d3-a456-426614174000",
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "isUnique": true,
      "lastModifiedAt": "2026-01-01T00:00:00.000Z",
      "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 CustomFieldDefinition

get

Get a single CustomFieldDefinition by ID

Authorizations

Path parameters

idstringRequired

CustomFieldDefinition ID

Responses

200

Successful response

application/json

codestringRequired

createdAtstring · date-timeRequired

entityDefinitionIDstring · uuidRequired

idstring · uuidRequired

isUniquebooleanRequired

lastModifiedAtstring · date-timeRequired

repositoryIDstring · uuidRequired

401

Unauthorized

application/json

404

Not found

application/json

500

Internal server error

application/json

get/customFieldDefinitions/{id}

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

{
  "code": "text",
  "createdAt": "2026-01-01T00:00:00.000Z",
  "entityDefinitionID": "123e4567-e89b-12d3-a456-426614174000",
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "isUnique": true,
  "lastModifiedAt": "2026-01-01T00:00:00.000Z",
  "name": {
    "en_us": "English text",
    "nl_nl": "Nederlandse tekst"
  },
  "repositoryID": "123e4567-e89b-12d3-a456-426614174000"
}

List CustomFieldDefinition creation proposals

get

List all createCustomFieldDefinitions proposals. These are proposed changes to create new CustomFieldDefinition 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: entityDefinitionID

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

Authorizations

Query parameters

entityDefinitionIDstringOptional

Filter by entityDefinitionID (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/createCustomFieldDefinitions

GET /createCustomFieldDefinitions HTTP/1.1
Accept: */*

{
  "data": [
    {
      "code": "text",
      "entityDefinitionID": "123e4567-e89b-12d3-a456-426614174000",
      "isProposalExecutionFailed": true,
      "isProposalResolved": false,
      "isUnique": true,
      "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 CustomFieldDefinitions

post

Create new proposals to add CustomFieldDefinition 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 · CreateCreateCustomFieldDefinitionProposalRequest[]

codestringRequired

entityDefinitionIDstring · uuidRequired

isUniquebooleanRequired

repositoryIDstring · uuidRequired

Responses

201

Created successfully

application/json

codestringRequired

entityDefinitionIDstring · uuidRequired

isProposalExecutionFailedbooleanRead-onlyRequired

isProposalResolvedbooleanRead-onlyRequiredExample: false

isUniquebooleanRequired

proposalExecutionErrorTextstringRead-onlyOptional

repositoryIDstring · uuidRequired

requestIDstring · uuidRead-onlyRequired

subjectIDstring · uuidRead-onlyRequired

400

Bad request

application/json

401

Unauthorized

application/json

500

Internal server error

application/json

post/createCustomFieldDefinitions

POST /createCustomFieldDefinitions HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 207

[
  {
    "code": "text",
    "entityDefinitionID": "123e4567-e89b-12d3-a456-426614174000",
    "isUnique": true,
    "name": {
      "en_us": "English text",
      "nl_nl": "Nederlandse tekst"
    },
    "repositoryID": "123e4567-e89b-12d3-a456-426614174000"
  }
]

[
  {
    "code": "text",
    "entityDefinitionID": "123e4567-e89b-12d3-a456-426614174000",
    "isProposalExecutionFailed": true,
    "isProposalResolved": false,
    "isUnique": true,
    "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 CustomFieldDefinition creation proposal

get

Get details of a specific CustomFieldDefinition creation proposal by ID

Authorizations

Path parameters

idstringRequired

CreateCustomFieldDefinitionProposal ID

Responses

200

Successful response

application/json

codestringRequired

entityDefinitionIDstring · uuidRequired

isProposalExecutionFailedbooleanRead-onlyRequired

isProposalResolvedbooleanRead-onlyRequiredExample: false

isUniquebooleanRequired

proposalExecutionErrorTextstringRead-onlyOptional

repositoryIDstring · uuidRequired

requestIDstring · uuidRead-onlyRequired

subjectIDstring · uuidRead-onlyRequired

401

Unauthorized

application/json

404

Not found

application/json

500

Internal server error

application/json

get/createCustomFieldDefinitions/{id}

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

{
  "code": "text",
  "entityDefinitionID": "123e4567-e89b-12d3-a456-426614174000",
  "isProposalExecutionFailed": true,
  "isProposalResolved": false,
  "isUnique": true,
  "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 CustomFieldDefinition deletion proposals

get

List all deleteCustomFieldDefinitions proposals. These are proposed changes to delete CustomFieldDefinition 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/deleteCustomFieldDefinitions

GET /deleteCustomFieldDefinitions 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 CustomFieldDefinitions

post

Create new proposals to delete CustomFieldDefinition 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 · CreateDeleteCustomFieldDefinitionProposalRequest[]

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/deleteCustomFieldDefinitions

POST /deleteCustomFieldDefinitions 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 CustomFieldDefinition deletion proposal

get

Get details of a specific CustomFieldDefinition deletion proposal by ID

Authorizations

Path parameters

idstringRequired

DeleteCustomFieldDefinitionProposal 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/deleteCustomFieldDefinitions/{id}

GET /deleteCustomFieldDefinitions/{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 CustomFieldDefinition update proposals

get

List all updateCustomFieldDefinitions proposals. These are proposed changes to update existing CustomFieldDefinition 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: entityDefinitionID

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

Authorizations

Query parameters

entityDefinitionIDstringOptional

Filter by entityDefinitionID (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/updateCustomFieldDefinitions

GET /updateCustomFieldDefinitions HTTP/1.1
Accept: */*

{
  "data": [
    {
      "code": "text",
      "entityDefinitionID": "123e4567-e89b-12d3-a456-426614174000",
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "isProposalExecutionFailed": true,
      "isProposalResolved": false,
      "isUnique": true,
      "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 CustomFieldDefinitions

post

Create new proposals to update CustomFieldDefinition 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 · CreateUpdateCustomFieldDefinitionProposalRequest[]

codestringOptional

Omit this field to keep current value

entityDefinitionIDstring · uuidOptional

Omit this field to keep current value

idstring · uuidRequired

isUniquebooleanOptional

Omit this field to keep current value

repositoryIDstring · uuidRequired

Responses

201

Created successfully

application/json

codestringOptional

entityDefinitionIDstring · uuidOptional

idstring · uuidRequired

isProposalExecutionFailedbooleanRead-onlyRequired

isProposalResolvedbooleanRead-onlyRequiredExample: false

isUniquebooleanOptional

proposalExecutionErrorTextstringRead-onlyOptional

repositoryIDstring · uuidRequired

requestIDstring · uuidRead-onlyRequired

400

Bad request

application/json

401

Unauthorized

application/json

500

Internal server error

application/json

post/updateCustomFieldDefinitions

POST /updateCustomFieldDefinitions HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 251

[
  {
    "code": "text",
    "entityDefinitionID": "123e4567-e89b-12d3-a456-426614174000",
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "isUnique": true,
    "name": {
      "en_us": "English text",
      "nl_nl": "Nederlandse tekst"
    },
    "repositoryID": "123e4567-e89b-12d3-a456-426614174000"
  }
]

[
  {
    "code": "text",
    "entityDefinitionID": "123e4567-e89b-12d3-a456-426614174000",
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "isProposalExecutionFailed": true,
    "isProposalResolved": false,
    "isUnique": true,
    "name": {
      "en_us": "English text",
      "nl_nl": "Nederlandse tekst"
    },
    "proposalExecutionErrorText": "text",
    "repositoryID": "123e4567-e89b-12d3-a456-426614174000",
    "requestID": "123e4567-e89b-12d3-a456-426614174000"
  }
]

Get CustomFieldDefinition update proposal

get

Get details of a specific CustomFieldDefinition update proposal by ID

Authorizations

Path parameters

idstringRequired

UpdateCustomFieldDefinitionProposal ID

Responses

200

Successful response

application/json

codestringOptional

entityDefinitionIDstring · uuidOptional

idstring · uuidRequired

isProposalExecutionFailedbooleanRead-onlyRequired

isProposalResolvedbooleanRead-onlyRequiredExample: false

isUniquebooleanOptional

proposalExecutionErrorTextstringRead-onlyOptional

repositoryIDstring · uuidRequired

requestIDstring · uuidRead-onlyRequired

401

Unauthorized

application/json

404

Not found

application/json

500

Internal server error

application/json

get/updateCustomFieldDefinitions/{id}

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

{
  "code": "text",
  "entityDefinitionID": "123e4567-e89b-12d3-a456-426614174000",
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "isProposalExecutionFailed": true,
  "isProposalResolved": false,
  "isUnique": true,
  "name": {
    "en_us": "English text",
    "nl_nl": "Nederlandse tekst"
  },
  "proposalExecutionErrorText": "text",
  "repositoryID": "123e4567-e89b-12d3-a456-426614174000",
  "requestID": "123e4567-e89b-12d3-a456-426614174000"
}