Custom Field
A custom field allows you to create a customized field to track extra characteristics and attributes of a record. Custom field object allows you to perform the following operations:
- Retrieve a specific custom field or a list of custom fields
- Create a custom field
- Update a custom field
- Delete a custom field
- cURL
- NODE.JS
- PHP
- C#
- PYTHON
- JAVA
The Custom Field Object
asterisk denotes required| Name | Description | Format | Attributes |
|---|---|---|---|
| label | Name of the custom field | string | MaxLength = 50 Filterable, Sortable |
| createdById | Identifier of the user who created this object | uuid | Filterable |
| createdOn | Date and time when this object was created (UTC Now), in ISO 8601 date-time format, such as YYYY-MM-DDThh:mm:ss | date-time | Filterable, Sortable |
| customListId | Identifier of the linked custom list if the custom field is of type drop-down | uuid | |
| definitionId | Identifier of the custom field assigned to a module | uuid | Filterable |
| description | Represents the description of the custom field | string | MaxLength = 100 |
| id | Object identifier | uuid | Filterable |
| integrationSourceId | Identifier of the integration source for this object. This property is only used by internal BQE apps and does not have any significance for external users | string | Filterable, Sortable |
| lastUpdated | Last updated date and time value of this object in ISO 8601 date-time format, such as YYYY-MM-DDThh:mm:ss | date-time | Filterable, Sortable |
| lastUpdatedById | Identifier of the user who last updated this object | uuid | Filterable |
| length | Number of characters allowed in a custom field | int32 | |
| module | Represents the module to which a custom field can be assigned, e.g., activity, client, employee, etc. | CustomFieldModule Enumerated type: Click to see possible values and their descriptions. | Filterable |
| objectState | Represents the state of the object. e.g., new, unchanged, modified or deleted | ObjectState Enumerated type: Click to see possible values and their descriptions. | |
| token | Represents the token for update operations | int32 | |
| type | Represents the data type of custom field, e.g., text, date, etc. | CustomFieldType Enumerated type: Click to see possible values and their descriptions. | |
| version | Implements concurrency on this object | byte |
The Custom Field Object
Custom Field List
Use this method to retrieve a list of custom fields. You can optionally pass where, orderBy, and page as query parameters to filter the result. Use the fields parameter to request a subset of the model. By default, a complete model is returned.
Request URL
base_url/customfield
Method Overview
HTTP Method:
GET
Content Type:
application/json
Response Format:
json
Requires Authentication?
Yes
Headers:
Module:
Custom Field
Required Scopes:
read:core
Required Subscription:
View Subscription
Request Parameters asterisk denotes required
| Name | Parameter Type | Description | Format |
|---|---|---|---|
| fields | Query | Specifies the model properties you want in the response body | string |
| where | Query | Specifies only those records that match an expression in the query | string |
| orderBy | Query | Specifies the order of the records | string |
| page | Query | Specifies the page number and number of records on each page | string |
| expand | Query | string |
Response Body
| Name | Description | Format |
|---|---|---|
| label | Name of the custom field | string |
| createdById | Identifier of the user who created this object | uuid |
| createdOn | Date and time when this object was created (UTC Now), in ISO 8601 date-time format, such as YYYY-MM-DDThh:mm:ss | date-time |
| customListId | Identifier of the linked custom list if the custom field is of type drop-down | uuid |
| definitionId | Identifier of the custom field assigned to a module | uuid |
| description | Represents the description of the custom field | string |
| id | Object identifier | uuid |
| integrationSourceId | Identifier of the integration source for this object. This property is only used by internal BQE apps and does not have any significance for external users | string |
| lastUpdated | Last updated date and time value of this object in ISO 8601 date-time format, such as YYYY-MM-DDThh:mm:ss | date-time |
| lastUpdatedById | Identifier of the user who last updated this object | uuid |
| length | Number of characters allowed in a custom field | int32 |
| module | Represents the module to which a custom field can be assigned, e.g., activity, client, employee, etc. | CustomFieldModuleEnumerated type: Click to see possible values and their descriptions. |
| objectState | Represents the state of the object. e.g., new, unchanged, modified or deleted | ObjectStateEnumerated type: Click to see possible values and their descriptions. |
| token | Represents the token for update operations | int32 |
| type | Represents the data type of custom field, e.g., text, date, etc. | CustomFieldTypeEnumerated type: Click to see possible values and their descriptions. |
| version | Implements concurrency on this object | byte |
Example Request
Example Response
[
{
"label": "label",
"createdById": "31dc198f-6e2d-475d-9364-fa95d6f6a988",
"createdOn": "2025-04-24T05:08:28Z",
"customListId": "55b32dca-cdc4-44cd-a408-fa04bf6304ce",
"definitionId": "123118bc-bd1b-44a4-922c-003b084eeb03",
"description": "AssignedCustomField Description",
"id": "50d209e8-26f7-4e11-8376-0ffbcefbf94f",
"integrationSourceId": "integrationSourceId",
"lastUpdated": "2025-04-24T05:08:28Z",
"lastUpdatedById": "095d348f-4c2a-4d31-9f74-02f7df2dc3bb",
"length": 0,
"module": null,
"objectState": null,
"token": 0,
"type": null,
"version": "U3dhZ2dlciByb2Nrcw=="
}
]Retrieve a Custom Field
Use this method to retrieve a specific custom field. Pass id as the parameter.
Request URL
base_url/customfield/{id}
Method Overview
HTTP Method:
GET
Content Type:
application/json
Response Format:
json
Requires Authentication?
Yes
Headers:
Module:
Custom Field
Required Scopes:
read:core
Required Subscription:
View Subscription
Request Parameters asterisk denotes required
| Name | Parameter Type | Description | Format |
|---|---|---|---|
| id | Path | Custom field identifier | string |
Response Body
| Name | Description | Format |
|---|---|---|
| label | Name of the custom field | string |
| createdById | Identifier of the user who created this object | uuid |
| createdOn | Date and time when this object was created (UTC Now), in ISO 8601 date-time format, such as YYYY-MM-DDThh:mm:ss | date-time |
| customListId | Identifier of the linked custom list if the custom field is of type drop-down | uuid |
| description | Represents the description of the custom field | string |
| id | Object identifier | uuid |
| integrationSourceId | Identifier of the integration source for this object. This property is only used by internal BQE apps and does not have any significance for external users | string |
| lastUpdated | Last updated date and time value of this object in ISO 8601 date-time format, such as YYYY-MM-DDThh:mm:ss | date-time |
| lastUpdatedById | Identifier of the user who last updated this object | uuid |
| length | Number of characters allowed in a custom field | int32 |
| objectState | Represents the state of the object. e.g., new, unchanged, modified or deleted | ObjectStateEnumerated type: Click to see possible values and their descriptions. |
| token | Represents the token for update operations | int32 |
| type | Represents the data type of custom field, e.g., text, date, etc. | CustomFieldTypeEnumerated type: Click to see possible values and their descriptions. |
| version | Implements concurrency on this object | byte |
Example Request
Example Response
{
"label": "label",
"createdById": "c9e07f99-20ea-4fc4-82bd-e5343deb125a",
"createdOn": "2025-04-24T05:08:28Z",
"customListId": "4004b172-2bb9-401b-9189-f4905e640777",
"description": "CustomField Description",
"id": "32327fa7-8844-41a9-b724-1caa950cbc42",
"integrationSourceId": "integrationSourceId",
"lastUpdated": "2025-04-24T05:08:28Z",
"lastUpdatedById": "78985e5c-69c1-47af-9436-0120b57fec54",
"length": 0,
"objectState": null,
"token": 0,
"type": null,
"version": "U3dhZ2dlciByb2Nrcw=="
}Create a Custom Field
Use this method to save a custom field. Pass custom field as the parameter.
Request URL
base_url/customfield
Method Overview
HTTP Method:
POST
Content Type:
application/json
Response Format:
json
Requires Authentication?
Yes
Headers:
Module:
Custom Field
Required Scopes:
readwrite:core
Required Subscription:
View Subscription
Request Parameters asterisk denotes required
| Name | Parameter Type | Description | Format |
|---|---|---|---|
| body | Body | Custom field object | CustomField |
Response Body
| Name | Description | Format |
|---|---|---|
| label | Name of the custom field | string |
| createdById | Identifier of the user who created this object | uuid |
| createdOn | Date and time when this object was created (UTC Now), in ISO 8601 date-time format, such as YYYY-MM-DDThh:mm:ss | date-time |
| customListId | Identifier of the linked custom list if the custom field is of type drop-down | uuid |
| description | Represents the description of the custom field | string |
| id | Object identifier | uuid |
| integrationSourceId | Identifier of the integration source for this object. This property is only used by internal BQE apps and does not have any significance for external users | string |
| lastUpdated | Last updated date and time value of this object in ISO 8601 date-time format, such as YYYY-MM-DDThh:mm:ss | date-time |
| lastUpdatedById | Identifier of the user who last updated this object | uuid |
| length | Number of characters allowed in a custom field | int32 |
| objectState | Represents the state of the object. e.g., new, unchanged, modified or deleted | ObjectStateEnumerated type: Click to see possible values and their descriptions. |
| token | Represents the token for update operations | int32 |
| type | Represents the data type of custom field, e.g., text, date, etc. | CustomFieldTypeEnumerated type: Click to see possible values and their descriptions. |
| version | Implements concurrency on this object | byte |
Example Request
Example Response
{
"label": "label",
"createdById": "9220218f-5d0d-45f2-9aae-76136453fbc4",
"createdOn": "2025-04-24T05:08:28Z",
"customListId": "1a99dbbd-cb88-466e-84b2-87848d8f0643",
"description": "CustomField Description",
"id": "e0ed8679-485c-4b76-bc43-04f7eb330c2a",
"integrationSourceId": "integrationSourceId",
"lastUpdated": "2025-04-24T05:08:28Z",
"lastUpdatedById": "a0d46348-27ce-4f2f-a0ee-7ff9d0e2beda",
"length": 0,
"objectState": null,
"token": 0,
"type": null,
"version": "U3dhZ2dlciByb2Nrcw=="
}Create a Custom Field List
Use this method to save multiple custom fields. Pass model as the parameter.
Request URL
base_url/customfield/batch
Method Overview
HTTP Method:
POST
Content Type:
application/json
Response Format:
json
Requires Authentication?
Yes
Headers:
Module:
Custom Field
Required Scopes:
readwrite:core
Required Subscription:
View Subscription
Request Parameters asterisk denotes required
| Name | Parameter Type | Description | Format |
|---|---|---|---|
| body | Body | Custom field object | CustomFieldBatchRequest |
Response Body
| Name | Description | Format |
|---|---|---|
| batchSize | Represents the number of entities in a batch | int64 |
| createdById | Identifier of the user who created this object | uuid |
| createdOn | Date and time when this object was created (UTC Now), in ISO 8601 date-time format, such as YYYY-MM-DDThh:mm:ss | date-time |
| id | Object identifier | uuid |
| integrationSourceId | Identifier of the integration source for this object. This property is only used by internal BQE apps and does not have any significance for external users | string |
| lastUpdated | Last updated date and time value of this object in ISO 8601 date-time format, such as YYYY-MM-DDThh:mm:ss | date-time |
| lastUpdatedById | Identifier of the user who last updated this object | uuid |
| objectState | Represents the state of the object. e.g., new, unchanged, modified or deleted | ObjectStateEnumerated type: Click to see possible values and their descriptions. |
| progress | Represents the total number of entities processed | int64 |
| status | Represents the status of a job e.g., ready, running, completed, or terminated | string |
| token | Represents the token for update operations | int32 |
| type | Represents the type of a job e.g., create, update, or delete | string |
| version | Implements concurrency on this object | byte |
Example Request
Example Response
{
"batchSize": 0,
"createdById": "afba2ee7-a483-4407-903b-7c8d0f39a0c4",
"createdOn": "2025-04-24T05:08:28Z",
"id": "237259c1-8778-4f0d-b63a-40d0d2bbd9c8",
"integrationSourceId": "integrationSourceId",
"lastUpdated": "2025-04-24T05:08:28Z",
"lastUpdatedById": "31dcabde-bbe4-49b5-b0bd-3a3a9319328d",
"objectState": null,
"progress": 0,
"status": "status",
"token": 0,
"type": "type",
"version": "U3dhZ2dlciByb2Nrcw=="
}Create a Custom Field Assign
Use this method to assign multiple custom fields to a module.
Request URL
base_url/customfield/assign
Method Overview
HTTP Method:
POST
Content Type:
application/json
Response Format:
json
Requires Authentication?
Yes
Headers:
Module:
Custom Field
Required Scopes:
readwrite:core
Required Subscription:
View Subscription
Request Parameters asterisk denotes required
| Name | Parameter Type | Description | Format |
|---|---|---|---|
| body | Body | Custom field object | AssignCustomField |
Example Request
Create a Custom Field Unassign
Use this method to remove a custom field from a module.
Request URL
base_url/customfield/unassign
Method Overview
HTTP Method:
POST
Content Type:
application/json
Response Format:
json
Requires Authentication?
Yes
Headers:
Module:
Custom Field
Required Scopes:
readwrite:core
Required Subscription:
View Subscription
Request Parameters asterisk denotes required
| Name | Parameter Type | Description | Format |
|---|---|---|---|
| body | Body | Custom field object | UnAssignCustomField |
Example Request
Update a Custom Field
Use this method to update a specific custom field. Pass id as the parameter.
Request URL
base_url/customfield/{id}
Method Overview
HTTP Method:
PUT
Content Type:
application/json
Response Format:
json
Requires Authentication?
Yes
Headers:
Module:
Custom Field
Required Scopes:
readwrite:core
Required Subscription:
View Subscription
Request Parameters asterisk denotes required
| Name | Parameter Type | Description | Format |
|---|---|---|---|
| id | Path | Custom field identifier | string |
| body | Body | Custom field object | CustomField |
Response Body
| Name | Description | Format |
|---|
Example Request
Example Response
{
"label": "label",
"createdById": "c586dc15-7d2f-4bd2-a54f-bfed2b371179",
"createdOn": "2025-04-24T05:08:28Z",
"customListId": "2971f6a4-e3b6-44e9-99ce-91dd0ec0394e",
"description": "CustomField Description",
"id": "656afec2-6431-466e-b154-b394942e49f7",
"integrationSourceId": "integrationSourceId",
"lastUpdated": "2025-04-24T05:08:28Z",
"lastUpdatedById": "08879697-d5a0-4071-abcc-8bda8a2dddfd",
"length": 0,
"objectState": null,
"token": 0,
"type": null,
"version": "U3dhZ2dlciByb2Nrcw=="
}Delete a Custom Field
Use this method to delete a custom field. Pass id as the parameter. You can only delete a custom field if it is not assigned to any module.
Request URL
base_url/customfield/{id}
Method Overview
HTTP Method:
DELETE
Content Type:
application/json
Response Format:
N/A
Requires Authentication?
Yes
Headers:
Required Scopes:
readwrite:core
Required Subscription:
View Subscription
Request Parameters asterisk denotes required
| Name | Parameter Type | Description | Format |
|---|---|---|---|
| id | Path | Custom field identifier | string |
Example Request
Patch a Custom Field
Use this method to perform partial modifications to a custom field. Pass id and patch document as parameters.
Request URL
base_url/customfield/{id}
Method Overview
HTTP Method:
PATCH
Content Type:
application/json
Response Format:
json
Requires Authentication?
Yes
Headers:
Module:
Custom Field
Required Scopes:
readwrite:core
Required Subscription:
View Subscription
Request Parameters asterisk denotes required
| Name | Parameter Type | Description | Format |
|---|---|---|---|
| id | Path | Custom field identifier | string |
| body | Body | A document containing an array of objects with each object representing a single operation | CustomFieldPatchDocument |
Response Body
| Name | Description | Format |
|---|
Example Request
Example Response