Appearance

List Fields ​

Endpoint ​

http
GET /unified/crm/fields
Integrations supported
  • Affinity
  • Attio
  • Capsule
  • Close
  • Freshsales
  • Highlevel
  • HubSpot
  • Insightly
  • Monday CRM
  • Nutshell
  • Pipedrive
  • Planhat
  • Salesflare
  • Salesforce
  • Zendesk Sell
  • Zoho CRM
Partial response integrations

For partial response integrations, you will need to fetch the individual resource using the "get" endpoint to get the full response object.

  • Salesforce

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 returns the response with unified mappings applied.
  • raw returns the unprocessed, raw response from the remote API.
  • normalized applies the unified mappings and returns the data in a normalized format.
  • stream returns the response as a stream, which is ideal for transmitting large datasets, files, or binary data. Using streaming mode helps to efficiently handle large payloads or real-time data flows without requiring the entire data to be buffered in memory.

Defaults to unified.

All possible enum values:
  • unified
  • raw
  • normalized
  • stream
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
Integration specific notes
  • HubSpotThe entity to get the fields for
  • CloseThe entity to get the fields for
  • PipedriveThe entity to get the fields for
  • SalesforceThe entity to get the fields for
  • Zoho CRMThe entity to get the fields for
  • CapsuleThe entity to get the fields for
  • FreshsalesThe entity to get the field groups for
  • SalesflareThe entity to get the fields for
  • NutshellThe entity to get the fields for
  • HighlevelThe entity to get the fields for
All possible enum values:
  • account
  • contact
  • lead
  • note
  • opportunity
  • view
Enum support by integration
  • HubSpot
    • contact
    • account
    • opportunity
    • lead
  • Close
    • contact
    • account
    • opportunity
  • Pipedrive
    • contact
    • account
    • opportunity
    • lead
  • Salesforce
    • contact
    • lead
    • account
    • opportunity
  • Zoho CRM
    • contact
    • lead
    • account
    • note
    • opportunity
  • Capsule
    • contact
    • account
    • opportunity
  • Freshsales
    • contact
    • account
    • opportunity
  • Salesflare
    • contact
    • account
    • opportunity
  • Nutshell
    • contact
    • account
    • lead
  • Highlevel
    • contact
    • opportunity
  • Attio
    • account
    • contact
    • opportunity
  • Monday CRM
    • account
    • contact
    • opportunity
    • lead
  • Affinity
    • account
    • contact
    • view
Required in
  • Affinity
  • Attio
  • Capsule
  • Close
  • Freshsales
  • Highlevel
  • HubSpot
  • Monday CRM
  • Nutshell
  • Pipedrive
  • Salesflare
  • Salesforce
  • Zoho CRM
entity_type
string

The entity type the field belongs to

All possible enum values:
  • account
  • contact
  • lead
  • opportunity
  • project
  • task
Enum support by integration
  • Zendesk Sell
    • lead
    • contact
    • opportunity
    • account
  • Insightly
    • task
    • contact
    • account
    • opportunity
    • project
    • lead
Required in
  • Zendesk Sell
Supported in
  • Insightly
sort_by

The field to sort the resource by. Should be in format { fieldName: direction }. The direction can be asc or desc.

All possible enum values:
  • name
Supported in
  • Planhat
name
string

The field's name. This is the name of the property in the entity.

Supported in
  • Salesflare
workspace
object
Required in
  • Highlevel
id
string
REQUIRED · 

Response Body ​

result
object[]

List of Fields

id
string

The field's unique identifier

Supported in
  • Affinity
  • Attio
  • Capsule
  • Close
  • Freshsales
  • Highlevel
  • HubSpot
  • Insightly
  • Monday CRM
  • Nutshell
  • Pipedrive
  • Planhat
  • Salesflare
  • Salesforce
  • Zendesk Sell
  • Zoho CRM
name
string

The field's name. This is the name of the property in the entity.

Supported in
  • Affinity
  • Attio
  • Capsule
  • Close
  • Freshsales
  • Highlevel
  • HubSpot
  • Insightly
  • Monday CRM
  • Nutshell
  • Pipedrive
  • Planhat
  • Salesflare
  • Salesforce
  • Zendesk Sell
  • Zoho CRM
label
string

The field's label

Supported in
  • Affinity
  • Attio
  • Capsule
  • Close
  • Freshsales
  • Highlevel
  • HubSpot
  • Insightly
  • Monday CRM
  • Nutshell
  • Pipedrive
  • Planhat
  • Salesflare
  • Zendesk Sell
  • Zoho CRM
description
string

The field's description

Supported in
  • Attio
  • Capsule
  • Close
  • HubSpot
  • Insightly
  • Monday CRM
  • Pipedrive
  • Salesforce
type
string

The field's type

All possible enum values:
  • string
  • text
  • rich_text
  • number
  • boolean
  • date
  • datetime
  • time
  • enum
  • array
  • file
  • address
Supported in
  • Affinity
  • Attio
  • Capsule
  • Close
  • Freshsales
  • Highlevel
  • HubSpot
  • Insightly
  • Monday CRM
  • Nutshell
  • Pipedrive
  • Planhat
  • Salesflare
  • Salesforce
  • Zendesk Sell
  • Zoho CRM
is_hidden
boolean

Whether the field is hidden

Supported in
  • Attio
  • Freshsales
  • HubSpot
  • Insightly
  • Planhat
  • Zoho CRM
is_unique
boolean

Whether the field is unique

Supported in
  • Attio
  • HubSpot
is_required
boolean

Whether the field is required

Supported in
  • Attio
  • Capsule
  • Freshsales
  • Pipedrive
  • Planhat
  • Salesflare
  • Zoho CRM
is_editable
boolean

Whether the field is editable

Supported in
  • Attio
  • Close
  • HubSpot
  • Pipedrive
options
object[]

The field's options

Supported in
  • Affinity
  • Capsule
  • Close
  • Freshsales
  • Highlevel
  • HubSpot
  • Insightly
  • Monday CRM
  • Nutshell
  • Pipedrive
  • Planhat
  • Salesflare
  • Zendesk Sell
  • 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
  • Attio
  • Close
  • HubSpot
  • Pipedrive
  • Salesforce
  • Zendesk Sell
  • Zoho CRM
entity_type
string

The entity type the field belongs to

All possible enum values:
  • contact
  • account
  • opportunity
Supported in
  • Attio
  • Capsule
  • Close
  • Freshsales
  • Highlevel
  • HubSpot
  • Insightly
  • Monday CRM
  • Nutshell
  • Pipedrive
  • Salesflare
  • Zendesk Sell
  • Zoho CRM
field_groups
object[]
References: FieldGroups → id
Supported in
  • Freshsales
  • Highlevel
  • 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
  • Highlevel
  • HubSpot
  • Pipedrive
  • Salesforce
  • Zendesk Sell
  • Zoho CRM
updated_at
string · date-time

The date and time of the field's last update

Supported in
  • Close
  • HubSpot
  • Pipedrive
  • Salesforce
  • Zendesk Sell
  • Zoho CRM
urls
object[]

The field's urls

Supported in
  • Attio
  • Close
  • Monday CRM
  • Pipedrive
  • Salesforce
  • Zendesk Sell
  • Zoho CRM
url
string

The field's URL

type
string

The field's URL type

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.