List deals
Lists the gallery's pipeline deals with cursor pagination. Filter by `status`, `stage_id`, or `contact_id`.
Lists the gallery's pipeline deals with cursor pagination. Filter by status, stage_id, or contact_id.
Authorization
bearerAuth deals:readA gallery API key, sent as Authorization: Bearer gpk_… (or the x-api-key header).
In: header
Scope: deals:read
Query Parameters
Page size. Defaults to 20; the maximum is 100.
1 <= value <= 200100Opaque cursor from the previous page's next_cursor. Omit for the first page.
Filter to the given status; the schema's enum lists the values.
Value in
- "open"
- "won"
- "lost"
Filter to the given stage id.
Filter to the given contact id.
Filter to the given tag id.
1 <= items <= 10Response Body
application/json
application/problem+json
application/problem+json
application/problem+json
application/problem+json
application/problem+json
application/problem+json
{ "data": [ { "id": "string", "contact_id": "string", "stage_id": "string", "title": "string", "status": "open", "expected_value_cents": -9007199254740991, "currency": "string", "owner_id": "string", "expected_close_date": "string", "won_sale_id": "string", "notes": "string", "position": -9007199254740991, "metadata": { "property1": "string", "property2": "string" }, "created_at": "string", "updated_at": "string" } ], "next_cursor": "string"}{ "type": "../dictionary", "title": "string", "status": 0, "detail": "string", "code": "invalid_request", "retry": "permanent", "details": null}{ "type": "../dictionary", "title": "string", "status": 0, "detail": "string", "code": "invalid_request", "retry": "permanent", "details": null}{ "type": "../dictionary", "title": "string", "status": 0, "detail": "string", "code": "invalid_request", "retry": "permanent", "details": null}{ "type": "../dictionary", "title": "string", "status": 0, "detail": "string", "code": "invalid_request", "retry": "permanent", "details": null}{ "type": "../dictionary", "title": "string", "status": 0, "detail": "string", "code": "invalid_request", "retry": "permanent", "details": null}{ "type": "../dictionary", "title": "string", "status": 0, "detail": "string", "code": "invalid_request", "retry": "permanent", "details": null}