CRM V4
Pipelines
GET
Retrieve CRM V4 pipeline stages — one row per board/column pair, ordered by board and stage position.
Filters:
organizationId(required)integrationId(optional)boardId,boardType(LEAD, OPPORTUNITY, EXPANSION, ACQUISITION)
ClientIdAuthClientSecretAuthheader
x-client-id<token>Client ID
header
x-client-secret<token>Client secret
organizationId*stringOrganization identifier (required)
integrationId?stringIntegration identifier (optional)
boardId?stringBoard (pipeline) identifier (optional)
boardType?stringBoard type: LEAD, OPPORTUNITY, EXPANSION or ACQUISITION (optional)
page?integerPage number (default: 1)
Range
1 <= valueDefault
1limit?integerResults per page (default: 500, max: 5000)
Range
1 <= value <= 5000Default
500Successful response
application/json- response
data?array<>meta?curl -X GET "https://example.com/v1/crm-v4/pipelines?organizationId=organization_123"{ "data": [ { "board_id": "string", "board_title": "string", "board_type": "string", "board_description": "string", "column_id": "string", "column_title": "string", "column_order": 0, "phase_type": "string", "ideal_card_life_time": 0, "next_board_column_id": "string", "created_at": "2019-08-24T14:15:22Z", "tenant_id": "string", "integration_id": "string", "organization_id": "string", "user_id": "string", "document_id": "string", "inserted_at": "2019-08-24T14:15:22Z", "integration_name": "string" } ], "meta": { "page": 0, "limit": 0, "hasNextPage": true, "hasPreviousPage": true }}