CRM V4
Pipelines
GET
Retorna as etapas de pipeline do CRM V4 — uma linha por par board/coluna, ordenadas por board e posição da etapa.
Filtros:
organizationId(obrigatório)integrationId(opcional)boardId,boardType(LEAD, OPPORTUNITY, EXPANSION, ACQUISITION)
ClientIdAuthClientSecretAuthheader
x-client-id<token>Client ID
header
x-client-secret<token>Client secret
organizationId*stringIdentificador da organização (obrigatório)
integrationId?stringIdentificador da integração (opcional)
boardId?stringIdentificador do board (pipeline) (opcional)
boardType?stringTipo de board: LEAD, OPPORTUNITY, EXPANSION ou ACQUISITION (opcional)
page?integerNúmero da página (padrão: 1)
Intervalo
1 <= valuePadrão
1limit?integerResultados por página (padrão: 500, máx.: 5000)
Intervalo
1 <= value <= 5000Padrão
500Resposta de sucesso
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 }}