Appearance

Get Pipelines ​

Endpoint ​

http
GET /unified/crm/pipelines/{id}
Integrations supported
  • Capsule
  • Insightly
  • Pipedrive
  • Pipeliner

Path parameters ​

id
string
REQUIRED · 

The ID of the resource.

Example: 23423523

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_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

Response Body ​

id
string
REQUIRED · 

The unique identifier for the pipeline

Supported in
  • Capsule
  • Insightly
  • Pipedrive
  • Pipeliner
name
string

The name of the pipeline

Supported in
  • Capsule
  • Insightly
  • Pipedrive
  • Pipeliner
entity
string

The entity associated with the pipeline

All possible enum values:
  • contact
  • account
  • opportunity
Supported in
  • Insightly
  • Pipedrive
stages
object[]

The stages associated with the pipeline

Supported in
  • Pipeliner
id
string

The unique identifier for the stage

name
string

The name of the stage

status
string

The status of the entity at the stage

pipeline
object

The pipeline associated with the stage

id
string

The unique identifier for the pipeline

created_at
string · date-time

The date and time when the pipeline was created

Supported in
  • Capsule
  • Pipedrive
  • Pipeliner
updated_at
string · date-time

The date and time when the pipeline was updated

Supported in
  • Capsule
  • Pipedrive
  • Pipeliner
remote_data
object

Raw data returned from the remote API call.