v1

latestOpenAPI 3.1.02026-07-223614164.6 KB

Deals

List deals

Retrieve a list of deals in the workspace.

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

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.

Query parameters

limitinteger

The number of items to return.

cursorstring

A cursor for pagination across multiple pages of results. Don’t include this parameter on the first call. Use the pagination.nextLink value returned in a previous response to request subsequent results.

combinator'and' | 'or'

The logical operator to combine multiple filters.

filterobject

A record of filters to apply, following the format filter[attribute][operator]=value. The attribute is the name of the attribute to filter on, and the operator is one of the supported filter operators. Refer to Filterable fields to learn more about the supported attributes and operators.

Response

A paginated list of deals in the workspace.

deprecationsstring[]

Example response

{
  "data": {
    "items": [
      {
        "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"
            }
          ]
        }
      }
    ],
    "pagination": {
      "nextLink": "https://api.folk.app/v1/groups/grp_bc984b3f-0386-434d-82d7-a91eb6badd71/Deals?limit=20&cursor=eyJvZmZzZXQiOjIwfQ%3D%3D"
    }
  },
  "deprecations": [
    "This field is deprecated"
  ]
}