List objects

Retrieve a list of objects of one type in a group.

An object type that does not exist in the group returns a 404, whose message lists the object types of the group.

GET /v1/groups/{groupId}/{objectType}

List objects

cURL

curl --request GET \
  --url https://api.folk.app/v1/groups/{groupId}/{objectType} \
  --header 'Authorization: Bearer <token>'

200

{
  "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": "[e-mail]"
        },
        "customFieldValues": {
          "Status": "Active",
          "Deal value": "42000",
          "Close date": "2021-01-01",
          "Assignee": [
            {
              "id": "usr_c3606e3b-0a92-4849-90e5-88a8d3f388d6",
              "fullName": "Jane Doe",
              "email": "[e-mail]"
            }
          ]
        }
      }
    ],
    "pagination": {
      "nextLink": "https://api.folk.app/v1/groups/grp_bc984b3f-0386-434d-82d7-a91eb6badd71/Deals?limit=20&cursor=eyJvZmZzZXQiOjIwfQ%3D%3D"
    }
  }
}

Retrieve a paginated list of objects of a given type in a group.

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 objects belong to. Can be retrieved from the List groups endpoint.

Required string length: 40

objectType · string · required

The name of the object type, as shown in the folk app, such as Deals. It is case-sensitive, and spaces must be URL-encoded, e.g. Job%20Applications. See how to find the object types of a group.

Maximum string length: 500

Query Parameters

limit · integer · default: 20

The number of items to return.

Required range: 1 <= x <= 100

cursor · string

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.

Maximum string length: 512

combinator · enum<string> · default: and

The logical operator to combine multiple filters.

Available options: and, or

filter · object

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

200

application/json

A paginated list of objects of the type in the group.

data · object · required

Show child attributes

Example:

{
  "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": "[e-mail]"
      },
      "customFieldValues": {
        "Status": "Active",
        "Deal value": "42000",
        "Close date": "2021-01-01",
        "Assignee": [
          {
            "id": "usr_c3606e3b-0a92-4849-90e5-88a8d3f388d6",
            "fullName": "Jane Doe",
            "email": "[e-mail]"
          }
        ]
      }
    }
  ],
  "pagination": {
    "nextLink": "https://api.folk.app/v1/groups/grp_bc984b3f-0386-434d-82d7-a91eb6badd71/Deals?limit=20&cursor=eyJvZmZzZXQiOjIwfQ%3D%3D"
  }
}

deprecations · string[]

Example:

["This field is deprecated"]