--- title: "Retrieve deal" method: GET path: "/deals/{id}" tags: ["Deals"] --- # Retrieve deal `GET /deals/{id}` ## Request - Base URL: `https://api.pipelinecrm.com/api/v3` - URL: `https://api.pipelinecrm.com/api/v3/deals/{id}` - Auth: one of: - HTTP bearer - HTTP bearer and API key in header `app-key` - API key in query parameter `api_key` and API key in query parameter `app_key` ## Path parameters - `id` integer, required ## Response `200` Successful Response - DealAll - `id` integer: Unique identifier - `owner` object: A convenience object to get the full name of the deal [owner](#tag/users) - `id` integer - `full_name` string - `import_id` integer, nullable: The ID of the Import (if this deal was imported) - `expected_close_date_event_id` integer, nullable: The ID of the expected close date [Calendar Entry](#tag/calendar-entries-tasks-events) - `primary_contact` object, nullable: A convenience object for the [primary contact](#tag/people) of the deal - `id` integer - `full_name` string - `people` object[]: A convenience list of [people](#tag/people) associated to the deal. - `id` integer - `first_name` string - `last_name` string - `collaborators` object[]: A convenience list of Collaborators (deal's shared [users](#tag/users)) that includes basic attributes for each. - `id` integer - `api_key` string - `first_name` string - `last_name` string - `company` object, nullable: Convenience object containing ID and name of the [company](#tag/companies) this deal is associated to. - `id` integer - `name` string - `currency` object: The deal's currency - `code` string - `name` string - `symbol` string - `deal_stage` object, nullable: Convenience object containing ID, name and win probability of the deal's [stage](#tag/deal-stages) - `id` integer - `name` string - `percent` integer: Probability of closing assigned to the stage, 0–100. - `deal_loss_reason` object, nullable: Convenience object containing ID and name of the deal's [loss reason](#tag/deal-loss-reasons) - `id` integer - `name` string - `source` object: Convenience object containing ID and name of the deal's [lead source](#tag/lead-sources) - `id` integer - `name` string - `possible_notify_user_ids` integer[]: The list of [User](#tag/users) IDs that can be added to `notify_user_ids` on associated [notes](#tag/activities-notes). - `next_task_name` string: Name of the next calendar entry due associated with the deal - `next_task_id` integer: The ID of the next calendar entry due associated with the deal - `next_task_due` string: Due date of the next calendar entry due associated with the deal - `next_task_all_day` boolean: Is the next calendar entry due associated with the deal an all day event? - `tags` object[]: A convenience object for this deal record's [tags](#tag/predefined-contacts-tags) - `id` integer - `name` string - `created_at` string: Timestamp when the record was created (time zone in user's time zone). - `updated_at` string: Timestamp when the record was last touched (time zone in user's time zone). - `name` string: The name of the deal - `summary` string, nullable: Explanatory or descriptive text about the deal - `user_id` integer: The ID of the [user](#tag/users) who owns this deal - `status` integer, nullable: The ID of the [deal status](#tag/deal-statuses) for this deal. - `expected_close_date` string, nullable: The date the deal is expected to close by (YYYY-MM-DD format) - `closed_time` string, nullable: The date the deal actually closed (either won or lost). YYYY-MM-DD format. - `is_archived` boolean: Flag for archived status - `value` string, nullable: The deal's value in its currency. A decimal serialized as a string (see Conventions); send a number or a numeric string. - `primary_contact_id` integer, nullable: The ID of the primary contact [Person](#tag/people) record associated with this deal - `person_ids` integer[]: IDs of [Person](#tag/people) records associated to this deal - `shared_user_ids` integer[]: The array of [User](#tag/users) IDs with whom this deal's been shared (also known as Collaborators) - `company_id` integer, nullable: The ID of the [company](#tag/companies) associated to this deal - `company_name` string: Creates a new [Company](#tag/companies) associated to this deal if provided - `probability` integer, nullable: The probability, from 0-100, that the deal will close. Note that if you set the probability to 0 or 100, the deal will close. Similarly, if the deal is closed, and you set the probability to 1-99, the deal will re-open and closed_time will be set to nil. - `deal_stage_id` integer, nullable: ID of the [deal stage](#tag/deal-stages) this deal is in. - `deal_loss_reason_id` integer, nullable: The ID of the [Deal Loss Reason](#tag/deal-loss-reasons) for this deal. - `deal_loss_reason_notes` string, nullable: Explanatory or descriptive text about why the deal was lost - `deal_won_reason_id` integer, nullable: The ID of the [Deal Won Reason](#tag/deal-won-reasons) for this deal. - `deal_won_reason_notes` string, nullable: Explanatory or descriptive text about why the deal was won - `deal_source` integer: The ID of this deal's [Lead Source](#tag/lead-sources) - `custom_fields` object: Custom fields for the deal. See [custom fields](#tag/custom-fields) section for more info. - `tag_ids` integer[]: IDs of the [tags](#tag/predefined-contacts-tags) to set on this deal - `address_1` string, nullable: The first line of the deal's address - `address_2` string, nullable: The second line of the deal's address - `city` string, nullable: The city of the deal's address - `state` string, nullable: The state of the deal's address - `postal_code` string, nullable: The postal code of the deal's address - `country` string, nullable: The country of the deal's address ## Other responses - `400`: The request could not be processed as sent (for example a malformed id or an unsupported combination of parameters). - `404`: Deal not found --- [API](https://skmtc.dev/pipelinecrm/apis/pipeline-crm-api.md) · [All operations](https://skmtc.dev/pipelinecrm/apis/pipeline-crm-api/llms.txt) · [OpenAPI document](https://skmtc.dev/pipelinecrm/apis/pipeline-crm-api/revisions/53ebfcc83597?raw)