CRM V4
Oportunidades
GET
Retorna oportunidades do CRM V4 com etapa, valor do deal, responsável e timestamps do ciclo de vida.
Filtros:
organizationId(obrigatório)integrationId(opcional)boardId,columnId,phaseTypetype(OPPORTUNITY, EXPANSION, ACQUISITION)ownerIdcreatedStart,createdEnd
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)
columnId?stringIdentificador da etapa (coluna) (opcional)
phaseType?stringTipo de fase da etapa (opcional)
type?stringTipo de board do card: OPPORTUNITY, EXPANSION ou ACQUISITION (opcional)
ownerId?stringIdentificador do responsável (usuário) (opcional)
createdStart?stringInício do intervalo de data de criação (opcional)
Formato
date-timecreatedEnd?stringFim do intervalo de data de criação (opcional)
Formato
date-timepage?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/opportunities?organizationId=organization_123"{ "data": [ { "id": "string", "board_id": "string", "title": "string", "company_name": "string", "type": "string", "column_id": "string", "column_title": "string", "phase_type": "string", "owner_id": "string", "owner_name": "string", "total_deal_amount": 0, "sales_date": "2019-08-24T14:15:22Z", "lost_date": "2019-08-24T14:15:22Z", "labels": "string", "created_at": "2019-08-24T14:15:22Z", "updated_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 }}