Appearance

List Fields ​

Endpoint ​

http
GET /unified/crm/fields
Integrations supported
  • Capsule
  • Close
  • HubSpot
  • Pipedrive
  • Salesforce
  • Zoho CRM

Query parameters ​

Refer Specifying query parameters in Truto APIs

integrated_account_id
string · uuid
REQUIRED · 

The ID of the integrated account to use for the request.

Example: 62f44730-dd91-461e-bd6a-aedd9e0ad79d
truto_response_format
string

The format of the response.

  • unified will return the response with unified mappings applied.
  • raw will return the raw response from the remote API.
  • normalized will apply the unified mappings and return the data in a normalized format.

Defaults to unified.

All possible enum values:
  • unified
  • raw
  • normalized
Example: unified
truto_key_by
string

By default the result attribute is an array of objects. This parameter allows you to specify a field in each result objects to use as key, which transforms the result array into an object with the array items keyed by the field. This is useful for when you want to use the result as a lookup table.

Example: id
truto_ignore_limit
boolean

Ignores the limit query parameter.

truto_ignore_remote_data
boolean

Excludes the remote_data attribute from the response.

truto_exclude_fields
array

Array of fields to exclude from the response.

Example: truto_exclude_fields[]=id&truto_exclude_fields[]=name
remote_query
object

Query parameters to pass to the underlying API without any transformations. Refer this guide to see how to structure the query parameters.

Example: remote_query[foo]=bar
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
  • Pipedrive
  • 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
  • Zoho CRM
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
  • Zoho CRM
options
object[]

The field's options

Supported in
  • Capsule
  • Close
  • HubSpot
  • Pipedrive
  • Zoho CRM
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
  • Pipedrive
  • Zoho CRM
entity_type
string

The entity type the field belongs to

All possible enum values:
  • contact
  • account
  • opportunity
Supported in
  • Capsule
  • Close
  • HubSpot
  • Pipedrive
  • Zoho CRM
field_groups
object[]
Supported in
  • HubSpot
id
string

The field group's unique identifier

name
string

The field group's name

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.