---
title: "List all deals"
method: GET
path: "/v2/deals"
tags: ["Deals"]
---

# List all deals

`GET /v2/deals`

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

## Query parameters

- `min_created` integer
- `max_created` integer
- `min_updated` integer
- `max_updated` integer
- `group` string
- `partner_key` string
- `customer_key` string[]
- `deal_key` string
- `limit` integer
- `starting_after` string
- `ending_before` string

## Response `200`

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

- object
  - `data` object, required
    - `has_more` boolean
    - `items` object[]
      - `created_at` integer — Immutable Unix timestamp in milliseconds taken at time of creation
      - `key` string — A unique identifier used to reference the object
      - `updated_at` integer — Unix timestamp in milliseconds taken at time of last update
      - `account_name` string, nullable — Name of the account
      - `amount` integer — Deal amount in **cents**
      - `close_date` string, date — Expected close date of deal as YYYY-MM-DD
      - `contact_first_name` string, nullable — First name of the account's contact
      - `contact_last_name` string, nullable — Last name of the account's contact
      - `customer_key` string, nullable — The unique key of the customer associated with this deal.
      - `external_key` string, nullable — Reference that can be used in place of the key.
      - `field_data` object, nullable
      - `fields` object[]
        - `api_name` string — API name of this field to be used on create / update / serialization. Created at time of field creation but can be edited
        - `description` string, nullable — Description of the field to be displayed to the partner
        - `external_type` string, nullable — Name that can be used for external systems
        - `field_key` string — Key of field that is presented
        - `help_text` string, nullable — 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 — 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 — Name of field that is presented
        - `options` object — Options to select from if this field is a picklist/checkbox
        - `placeholder_text` string, nullable — 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)
        - `read_only` boolean — Whether or not this field is read only
        - `required` boolean — Whether or not this field will be required when filling out its attached form
        - `type` string — The type of field that will be presented (input, picklist, number ect.)
        - `value` unknown
      - `group_key` string — The unique key of the group in which this deals's partner is in
      - `lost_reason` string, nullable — Reason for which the deal was lost.
      - `meta` object, nullable
      - `mold_key` string, nullable
      - `partner_key` string — The unique key of the partner who owns this deal
      - `source` 'partner' | 'vendor', nullable — Source of the deal, either 'partner' or 'vendor', defaults to 'partner' if not specified
      - `stage` string — Current stage of this deal. Must appear in Deals Stage list found in group settings.
      - `team` object, nullable — Details of team used in public API.
        - `created_at` integer — Immutable Unix timestamp in milliseconds taken at time of creation
        - `key` string — A unique identifier used to reference the object
        - `updated_at` integer — Unix timestamp in milliseconds taken at time of last update
        - `name` string — The name of the partner team
      - `team_member` object, nullable — Details of team member used in public API.
        - `created_at` integer — Immutable Unix timestamp in milliseconds taken at time of creation
        - `key` string — A unique identifier used to reference the object
        - `updated_at` integer — Unix timestamp in milliseconds taken at time of last update
        - `email` string — Email of the partner team member
        - `first_name` string — First name of the partner team member
        - `last_name` string — Last name of the partner team member
        - `personal_stack_key` string — The personal stack key of the partner team member
    - `total` integer, nullable
  - `message` string, required
  - `status` integer, required

## Other responses

- `400` — Bad Request Error
- `401` — Unauthorized Error
- `403` — Forbidden Error
- `404` — Not Found Error
- `500` — Internal Server Error

---

[API](https://skmtc.net/partnerstack/apis/partnerstack-api.md) · [All operations](https://skmtc.net/partnerstack/apis/partnerstack-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/partnerstack/partnerstack-api/versions/0f35aebe53a9/schema)