Skip to main content
GET
Get a deal
Retrieve a single object of a given type by its ID. Set the objectType path parameter to the name of the object type you want to read — Deals, Projects, Applications, or any other object type defined in the group. See Custom objects to find the object types available in a group.

Authorizations

Authorization
string
header
required

API key for authentication

Path Parameters

groupId
string
required

The ID of the group the deals belong to. Can be retrieved from the List groups endpoint.

Required string length: 40
objectType
string
required

The name of a deal custom field that can be retrieved from the List group custom fields endpoint.

Maximum string length: 500
objectId
string
required

The ID of the deal to retrieve.

Required string length: 40

Response

The retrieved deal in the workspace.

data
object
required

A deal in the workspace.

Example:
deprecations
string[]
Example: