List all deals

get https://api.partnerstack.com/api/v2/deals

Returns a list of your deals. The deals are
returned sorted by creation date, with the most recent deals
appearing first.

time	status	user agent
Retrieving recent requests…

Loading…

Query Params

min_created

int64

Applies a minimum epoch timestamp (ms) filter to the response created_at.

max_created

int64

Applies a maximum epoch timestamp (ms) filter to the response created_at.

min_updated

int64

Applies a minimum epoch timestamp (ms) filter to the response updated_at.

max_updated

int64

Applies a maximum epoch timestamp (ms) filter to the response updated_at.

group

string

Will filter for partnerships who are in a group with the specified name. Name must have spaces and special characters removed.

partner_key

string

Will filter to a specific partnership's partner_key, which can be found using the partnership's get endpoint or from the partnership view in your PartnerStack dashboard.

limit

integer

1 to 250

Defaults to 10

A limit on the number of items to be returned. Limits can range between 1 and 250, and the default is 10.

starting_after

string

A cursor for use in pagination, starting_after takes in an item key and the subsequent call will return the following items in the list. This is mutually exclusive with ending_before.

ending_before

string

A cursor for use in pagination, ending_before takes in an item key and the subsequent call will return the prior items in the list. This is mutually exclusive with starting_after.

Responses

Response body

object

data

object

required

has_more

boolean

items

array of objects

items

object

created_at

int64

Immutable Unix timestamp in milliseconds taken at time of creation

key

string

length ≤ 255

A unique identifier used to reference the object

updated_at

int64

Unix timestamp in milliseconds taken at time of last update

account_name

string | null

Name of the account

amount

int32

Deal amount in cents

close_date

date

Expected close date of deal as YYYY-MM-DD

contact_first_name

string | null

First name of the account's contact

contact_last_name

string | null

Last name of the account's contact

external_key

string | null

Reference that can be used in place of the key.

field_data

object | null

Has additional fields

fields

array of objects

fields

object

api_name

string

length ≤ 255

API name of this field to be used on create / update / serialization. Created at time of field creation but can be edited

external_type

string | null

Name that can be used for external systems

field_key

string

length ≤ 255

Key of field that is presented

help_text

string | null

The help text that is provided for this field

hidden

boolean

Whether or not this field is displayed when filling out its attached form

internal_name

string

length ≤ 255

Internal name of this field. Created by PartnerStack at time of field creation. Used when referencing field in created objects. Cannot be edited.

name

string

length ≤ 255

Name of field that is presented

options

object

Options to select from if this field is a picklist/checkbox

Has additional fields

placeholder_text

string | null

The text of the placeholder that is provided for this field

position

integer

The position that this field will be displayed in relation to others on the same form (index starts at 0)

required

boolean

Whether or not this field will be required when filling out its attached form

type

string

length ≤ 255

The type of field that will be presented (input, picklist, number ect.)

value

string

The value that was submitted to the field and stored on the target object

group_key

string

length ≤ 255

The unique key of the group in which this deals's partner is in

lost_reason

string | null

Reason for which the deal was lost.

200Returns a list of your deals. The deals are returned sorted by creation date, with the most recent deals appearing first.

400Bad Request Error

401Unauthorized Error

403Forbidden Error

404Not Found Error

500Internal Server Error