v1Deals

List all deals

Changed on
get/v1/deals

Request

  • Base URL: https://api4.kinbox.com.br (the document declares no server; this is the origin it was published from)
  • URL: https://api4.kinbox.com.br/v1/deals
  • Auth: none declared

Query parameters

limitnumber

A limit on the number of objects to be returned. Limit can range between 1 and 100.

cursorstring

A cursor for use in pagination. The cursor is the id of the last object returned in the previous request.

pipeline_idstring

Filter deals by pipeline id.

status'open' | 'won' | 'lost'

Filter deals by status (open, won, lost).

contact_idstring

Filter deals by the id of the contact associated with the deal.

organization_idstring
Example:42

Filtra os negócios pelo ID da organização (CRM) vinculada ao negócio.

created_at_fromstring

Only return deals that were created after this date.

created_at_tostring

Only return deals that were created before this date.

won_lost_date_fromstring

Only return deals that were won or lost after this date.

won_lost_date_tostring

Only return deals that were won or lost before this date.

Response

nextCursorstring nullable required

Cursor for the next page. Null if there are no more results.

Changes

  • c083bbfe8973Revision changes
    • info

      added the new optional query request parameter organization_id

    • info

      added the optional property // to the response with the status

  • 91830f0a8f54Revision changes
    • breaking

      the response property // became optional for the status