v1
latestOpenAPI 3.0.22026-07-24800528.1 KBList all deals
Returns a list of your deals. The deals are returned sorted by creation date, with the most recent deals appearing first.
Query parameters
Applies a minimum epoch timestamp (ms) filter to the response created_at.
Applies a maximum epoch timestamp (ms) filter to the response created_at.
Applies a minimum epoch timestamp (ms) filter to the response updated_at.
Applies a maximum epoch timestamp (ms) filter to the response updated_at.
Will filter for partnerships who are in a group with the specified name. Name must have spaces and special characters removed.
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.
Customer keys in which the results are filtered by
Deal key in which the results are filtered by. When provided, returns only the matching deal (or an empty list if not found).
A limit on the number of items to be returned. Limits can range between 1 and 250, and the default is 10.
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.
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.
Response
Returns a list of your deals. The deals are returned sorted by creation date, with the most recent deals appearing first.
Example response
{
"data": {
"items": [
{
"created_at": 1574181282399,
"key": "co_a80cb515fe",
"updated_at": 1574181282399,
"account_name": "Digital Agency Acme",
"amount": 25000,
"close_date": "2020-03-01",
"contact_first_name": "John",
"contact_last_name": "Smith",
"customer_key": "cus_a80cb515fe",
"external_key": "deal_1234",
"fields": [
{
"field_key": "field_fjkdlrh9i32nfew",
"name": "Company Address"
}
],
"group_key": "grup_UHrMpyoNbTBRuc",
"lost_reason": "Not the right fit",
"partner_key": "bertramgilfoyle",
"source": "partner",
"stage": "Working",
"team": {
"created_at": 1574181282399,
"key": "co_a80cb515fe",
"updated_at": 1574181282399,
"name": "Tushar"
},
"team_member": {
"created_at": 1574181282399,
"key": "co_a80cb515fe",
"updated_at": 1574181282399,
"email": "tushten@partnerstack.com",
"first_name": "Tushar",
"last_name": "Sutherland",
"personal_stack_key": "stck_1234567890"
}
}
]
}
}