v1

latestOpenAPI 3.1.02026-07-223614164.6 KB

Deals

Get a deal

Retrieve an existing deal in the workspace.

get/v1/groups/{groupId}/{objectType}/{objectId}

Path parameters

groupIdstring required

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

objectTypestring required

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

objectIdstring required

The ID of the deal to retrieve.

Response

The retrieved deal in the workspace.

deprecationsstring[]

Example response

{
  "data": {
    "id": "obj_183ed5cc-3182-45de-84d1-d520f2604810",
    "name": "Project Alpha",
    "companies": [
      {
        "id": "com_92346499-30bf-4278-ae8e-4aa3ae2ace2c",
        "name": "Tech Corp"
      }
    ],
    "people": [
      {
        "id": "per_5fa60242-0756-4e31-8cca-30c2c5ff1ac2",
        "fullName": "John Doe"
      }
    ],
    "createdAt": "2021-01-01T00:00:00.000Z",
    "createdBy": {
      "id": "usr_bc984b3f-0386-434d-82d7-a91eb6badd71",
      "fullName": "John Doe",
      "email": "john.doe@example.com"
    },
    "customFieldValues": {
      "Status": "Active",
      "Deal value": "42000",
      "Close date": "2021-01-01",
      "Assignee": [
        {
          "id": "usr_c3606e3b-0a92-4849-90e5-88a8d3f388d6",
          "fullName": "Jane Doe",
          "email": "jane@example.com"
        }
      ]
    }
  },
  "deprecations": [
    "This field is deprecated"
  ]
}