Appearance

List Stages ​

Endpoint ​

http
GET /unified/crm/stages
Integrations supported
  • ActiveCampaign
  • Capsule
  • Close
  • Copper
  • Highlevel
  • HubSpot
  • Insightly
  • Keap
  • Nutshell
  • Outreach
  • Pipedrive
  • Pipeliner
  • Salesflare
  • Salesforce
  • Teamleader
  • Zendesk Sell

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
pipeline
object

The pipeline of the stages.

Required in
  • HubSpot
Supported in
  • Capsule
  • Pipedrive
  • Pipeliner
  • Salesflare
  • Zendesk Sell
id
string

The unique identifier of the pipeline.

name
string

The name of the pipeline

name
string

The stage's name

Supported in
  • Outreach
  • Pipeliner
  • Salesflare
  • Salesforce
  • Zendesk Sell
position
number

The order of stage in the pipeline

Supported in
  • Outreach
  • Pipeliner
created_at
string · date-time

The date and time of the stage's creation

Supported in
  • Outreach
  • Pipeliner
  • Salesforce
updated_at
string · date-time

The date and time of the stage's last update

Supported in
  • Outreach
  • Pipeliner
  • Salesforce
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:
  • created_at
  • name
  • position
  • updated_at
Enum support by integration
  • Outreach
    • name
    • created_at
    • updated_at
    • position
  • Zendesk Sell
    • name
    • position
  • Pipeliner
    • created_at
    • updated_at
    • name
  • Salesflare
    • name
    • created_at
    • updated_at
Supported in
  • Outreach
  • Pipeliner
  • Salesflare
  • Zendesk Sell
status
string

The status of the stage

All possible enum values:
  • active
  • inactive
Supported in
  • Pipeliner
  • Zendesk Sell
workspace
object
Required in
  • Highlevel
id
string
REQUIRED · 

Response Body ​

result
object[]

List of Stages

id
string
REQUIRED · 

The stage's unique identifier

Supported in
  • ActiveCampaign
  • Capsule
  • Close
  • Copper
  • Highlevel
  • HubSpot
  • Insightly
  • Keap
  • Nutshell
  • Outreach
  • Pipedrive
  • Pipeliner
  • Salesflare
  • Salesforce
  • Teamleader
  • Zendesk Sell
name
string

The stage's name

Supported in
  • ActiveCampaign
  • Capsule
  • Close
  • Copper
  • Highlevel
  • HubSpot
  • Insightly
  • Keap
  • Nutshell
  • Outreach
  • Pipedrive
  • Pipeliner
  • Salesflare
  • Salesforce
  • Teamleader
  • Zendesk Sell
position
number

The order of stage in the pipeline

Supported in
  • Highlevel
  • HubSpot
  • Insightly
  • Keap
  • Nutshell
  • Outreach
  • Pipedrive
  • Pipeliner
  • Salesflare
  • Zendesk Sell
status
string

The status of the stage

All possible enum values:
  • active
  • inactive
Supported in
  • Capsule
  • Close
  • HubSpot
  • Outreach
  • Pipedrive
  • Pipeliner
  • Zendesk Sell
pipeline
object

The pipeline this stage is part of

Supported in
  • Capsule
  • Close
  • Highlevel
  • Insightly
  • Nutshell
  • Pipedrive
  • Pipeliner
  • Salesflare
  • Zendesk Sell
id
string

The pipeline's unique identifier

name
string

The name of the pipeline

created_at
string · date-time

The date and time of the stage's creation

Supported in
  • ActiveCampaign
  • Capsule
  • HubSpot
  • Outreach
  • Pipedrive
  • Pipeliner
  • Salesflare
  • Salesforce
  • Zendesk Sell
updated_at
string · date-time

The date and time of the stage's last update

Supported in
  • ActiveCampaign
  • Capsule
  • HubSpot
  • Outreach
  • Pipedrive
  • Pipeliner
  • Salesflare
  • Salesforce
  • Zendesk Sell
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.