List Fields ​
Endpoint ​
http
GET /unified/crm/fields
Integrations supported
- Capsule
- Close
- HubSpot
- Pipedrive
- Salesforce
- Zoho CRM
Query parameters ​
integrated_account_id
string · uuid
REQUIRED · The ID of the integrated account to use for the request.
Example:
62f44730-dd91-461e-bd6a-aedd9e0ad79d
entity
string
The entity to get the fields for
All possible enum values:
account
activity
contact
lead
note
opportunity
Enum support by integration
- HubSpot
contact
account
opportunity
- Close
contact
account
opportunity
activity
- Pipedrive
contact
account
opportunity
- Salesforce
contact
lead
account
opportunity
- Zoho CRM
contact
lead
account
note
opportunity
- Capsule
contact
account
opportunity
Required in
- Capsule
- Close
- HubSpot
- Pipedrive
- Salesforce
- Zoho CRM
Response Body ​
result
object[]
List of Fields
id
string
The field's unique identifier
Supported in
- Capsule
- Close
- HubSpot
- Pipedrive
- Salesforce
- Zoho CRM
name
string
The field's name. This is the name of the property in the entity.
Supported in
- Capsule
- Close
- HubSpot
- Pipedrive
- Salesforce
- Zoho CRM
label
string
The field's label
Supported in
- Capsule
- Close
- HubSpot
- Pipedrive
- Zoho CRM
description
string
The field's description
Supported in
- Capsule
- Close
- HubSpot
- Salesforce
type
string
The field's type
All possible enum values:
string
text
rich_text
number
boolean
date
datetime
time
enum
array
file
Supported in
- Capsule
- Close
- HubSpot
- Pipedrive
is_hidden
boolean
Whether the field is hidden
Supported in
- HubSpot
- Zoho CRM
is_unique
boolean
Whether the field is unique
Supported in
- HubSpot
is_required
boolean
Whether the field is required
Supported in
- Pipedrive
options
object[]
The field's options
Supported in
- Capsule
- Close
- HubSpot
- Pipedrive
label
string
The option's label
value
string
The option's value
description
string
The option's description
is_hidden
boolean
Whether the option is hidden
is_user_defined
boolean
Whether the field is user defined
Supported in
- HubSpot
entity_type
string
The entity type the field belongs to
All possible enum values:
contact
account
opportunity
Supported in
- Capsule
- Close
- HubSpot
created_at
string · date-time
The date and time of the field's creation
Supported in
- Close
- HubSpot
- Pipedrive
- Salesforce
- Zoho CRM
updated_at
string · date-time
The date and time of the field's last update
Supported in
- Close
- HubSpot
- Pipedrive
- Salesforce
- Zoho CRM
remote_data
object
Raw data returned from the remote API call.
next_cursor
string
The cursor to use for the next page of results. Pass this value as `next_cursor` in the query parameter in the next request to get the next page of results.