AG5.comSupportRequest a demo

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
get
GET /customFieldDefinitions HTTP/1.1
Host: 
X-API-Key: YOUR_API_KEY
Accept: */*

{
  "data": [
    {
      "code": "text",
      "createdAt": "2025-09-13T21:46:08.633Z",
      "entityDefinitionID": "123e4567-e89b-12d3-a456-426614174000",
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "lastModifiedAt": "2025-09-13T21:46:08.633Z",
      "name": {
        "en": "English text",
        "nl": "Nederlandse tekst"
      },
      "repositoryID": "123e4567-e89b-12d3-a456-426614174000"
    }
  ],
  "pagination": {
    "count": 1,
    "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
get
GET /customFieldDefinitions/{id} HTTP/1.1
Host: 
X-API-Key: YOUR_API_KEY
Accept: */*

{
  "code": "text",
  "createdAt": "2025-09-13T21:46:08.633Z",
  "entityDefinitionID": "123e4567-e89b-12d3-a456-426614174000",
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "lastModifiedAt": "2025-09-13T21:46:08.633Z",
  "name": {
    "en": "English text",
    "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
get
GET /createCustomFieldDefinitions HTTP/1.1
Host: 
X-API-Key: YOUR_API_KEY
Accept: */*

{
  "data": [
    {
      "code": "text",
      "entityDefinitionID": "123e4567-e89b-12d3-a456-426614174000",
      "isProposalExecutionFailed": true,
      "isProposalResolved": false,
      "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"
    }
  ],
  "pagination": {
    "count": 1,
    "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[]
codestringRequired
entityDefinitionIDstring · uuidRequired
repositoryIDstring · uuidRequired
Responses
201

Created successfully

application/json
post
POST /createCustomFieldDefinitions HTTP/1.1
Host: 
X-API-Key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 185

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

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
get
GET /createCustomFieldDefinitions/{id} HTTP/1.1
Host: 
X-API-Key: YOUR_API_KEY
Accept: */*

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

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
get
GET /deleteCustomFieldDefinitions HTTP/1.1
Host: 
X-API-Key: YOUR_API_KEY
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": {
    "count": 1,
    "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[]
idstring · uuidRequired
repositoryIDstring · uuidRequired
Responses
201

Created successfully

application/json
post
POST /deleteCustomFieldDefinitions HTTP/1.1
Host: 
X-API-Key: YOUR_API_KEY
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
get
GET /deleteCustomFieldDefinitions/{id} HTTP/1.1
Host: 
X-API-Key: YOUR_API_KEY
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
get
GET /updateCustomFieldDefinitions HTTP/1.1
Host: 
X-API-Key: YOUR_API_KEY
Accept: */*

{
  "data": [
    {
      "code": "text",
      "entityDefinitionID": "123e4567-e89b-12d3-a456-426614174000",
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "isProposalExecutionFailed": true,
      "isProposalResolved": false,
      "name": {
        "en": "English text",
        "nl": "Nederlandse tekst"
      },
      "proposalExecutionErrorText": "text",
      "repositoryID": "123e4567-e89b-12d3-a456-426614174000",
      "requestID": "123e4567-e89b-12d3-a456-426614174000"
    }
  ],
  "pagination": {
    "count": 1,
    "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[]
codestringOptional

Omit this field to keep current value

entityDefinitionIDstring · uuidOptional

Omit this field to keep current value

idstring · uuidRequired
repositoryIDstring · uuidRequired
Responses
201

Created successfully

application/json
post
POST /updateCustomFieldDefinitions HTTP/1.1
Host: 
X-API-Key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 229

[
  {
    "code": "text",
    "entityDefinitionID": "123e4567-e89b-12d3-a456-426614174000",
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "name": {
      "en": "English text",
      "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,
    "name": {
      "en": "English text",
      "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
get
GET /updateCustomFieldDefinitions/{id} HTTP/1.1
Host: 
X-API-Key: YOUR_API_KEY
Accept: */*

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

Was this helpful?