Sign in

v1

latestOpenAPI 3.0.22026-08-045831103.6 KB
Deals

List deals

Retrieve a paginated list of deals

get/v1/deals

Query parameters

limitinteger

Max number of rows returned

offsetinteger

Number of rows skipped of the result

pageinteger

Select the page of the result

origin_idstring uuid
Example:8feade82-d77b-4e8b-9d35-fd43e972b5c8

Filter by origin ID

created_at_startstring date-time
Example:2020-01-01T14:15:00.000000+00:00

Filter by created_at using GTE operator

created_at_endstring date-time
Example:2020-01-01T14:15:00.000000+00:00

Filter by created_at using LTE operator

updated_at_startstring date-time
Example:2020-01-01T14:15:00.000000+00:00

Filter by updated_at using GTE operator

updated_at_endstring date-time
Example:2020-01-01T14:15:00.000000+00:00

Filter by updated_at using LTE operator

user_idstring uuid
Example:8feade82-d77b-4e8b-9d35-fd43e972b5c8

Filter by user ID

user_emailstring
Example:user@email.com

Filter by user e-mail

contact_idstring uuid
Example:8feade82-d77b-4e8b-9d35-fd43e972b5c8

Filter by contact ID

phonestring
Example:999999999

Filter by contact phone

emailstring
Example:contact@email.com

Filter by contact e-mail

tag_idsstring
Example:8feade82-d77b-4e8b-9d35-fd43e972b5c8,99999999-d77b-4e8b-9d35-fd43e972b999

Filter by tag IDs using OR operator. Separated by ','

tag_namesstring
Example:tag1,tag2,tag3

Filter by tag names using OR operator. Separated by ','

status'OPEN' | 'WON' | 'LOST'

Filter by status

stage_idstring uuid
Example:8feade82-d77b-4e8b-9d35-fd43e972b5c8

Filter by stage ID

updated_stage_at_startstring date-time
Example:2020-01-01T14:15:00.000000+00:00

Filter by updated_stage_at using GTE operator

updated_stage_at_endstring date-time
Example:2020-01-01T14:15:00.000000+00:00

Filter by updated_stage_at using LTE operator

fieldsobject

Filter by deal fields. Can be used multiple times for each field

won_at_startstring date-time
Example:2020-01-01T14:15:00.000000+00:00

Filter by won_at using GTE operator

won_at_endstring date-time
Example:2020-01-01T14:15:00.000000+00:00

Filter by won_at using LTE operator

lost_at_startstring date-time
Example:2020-01-01T14:15:00.000000+00:00

Filter by lost_at using GTE operator

lost_at_endstring date-time
Example:2020-01-01T14:15:00.000000+00:00

Filter by lost_at_at using LTE operator

Headers

api-tokenstring required

API Token

Response

A list of deals

statusinteger

Response status

totalCountinteger

Total items based on current filters

pageinteger

Current page

totalPagesinteger

Total pages based on current filters

hasNextboolean

Indicates that has next page

hasPreviousboolean

Indicates that has previous page

Example response

{
  "data": [
    {
      "id": "8feade82-d77b-4e8b-9d35-fd43e972b5c8",
      "origin_id": "8feade82-d77b-4e8b-9d35-fd43e972b5c8",
      "user": {
        "id": "8feade82-d77b-4e8b-9d35-fd43e972b5c8",
        "full_name": "User full name"
      },
      "contact": {
        "id": "8feade82-d77b-4e8b-9d35-fd43e972b5c8",
        "name": "Contact name",
        "email": "contact@email.com",
        "phone": "+5548999999999"
      },
      "created_at": "2020-01-01T14:15:00.000000+00:00",
      "stage_id": "8feade82-d77b-4e8b-9d35-fd43e972b5c8",
      "updated_stage_at": "2020-01-01T14:15:00.000000+00:00",
      "won_at": "2020-01-01T14:15:00.000000+00:00",
      "won_by": "8feade82-d77b-4e8b-9d35-fd43e972b5c8",
      "lost_status_id": "8feade82-d77b-4e8b-9d35-fd43e972b5c8",
      "lost_at": "2020-01-01T14:15:00.000000+00:00",
      "lost_by": "8feade82-d77b-4e8b-9d35-fd43e972b5c8"
    }
  ]
}