List deals

get

https://api.clint.digital/v1/deals

Retrieve a paginated list of deals

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

limit

integer

1 to 1000

Defaults to 200

Max number of rows returned

offset

integer

≥ 0

Defaults to 0

Number of rows skipped of the result

page

integer

≥ 1

Defaults to 1

Select the page of the result

origin_id

uuid

Filter by origin ID

created_at_start

date-time

Filter by created_at using GTE operator

created_at_end

date-time

Filter by created_at using LTE operator

updated_at_start

date-time

Filter by updated_at using GTE operator

updated_at_end

date-time

Filter by updated_at using LTE operator

user_id

uuid

Filter by user ID

user_email

string

Filter by user e-mail

contact_id

uuid

Filter by contact ID

phone

string

Filter by contact phone

string

Filter by contact e-mail

tag_ids

string

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

tag_names

string

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

status

string

enum

Defaults to OPEN

Filter by status

Allowed:

stage_id

uuid

Filter by stage ID

updated_stage_at_start

date-time

Filter by updated_stage_at using GTE operator

updated_stage_at_end

date-time

Filter by updated_stage_at using LTE operator

fields

object

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

won_at_start

date-time

Filter by won_at using GTE operator

won_at_end

date-time

Filter by won_at using LTE operator

lost_at_start

date-time

Filter by lost_at using GTE operator

lost_at_end

date-time

Filter by lost_at_at using LTE operator

Headers

api-token

string

required

API Token

Response

Language

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200A list of deals