GET
/
v1
/
companies
curl --request GET \
  --url https://api.folk.app/v1/companies \
  --header 'Authorization: Bearer <token>'
{
  "data": {
    "items": [
      {
        "id": "com_183ed5cc-3182-45de-84d1-d520f2604810",
        "name": "Tech Corp",
        "description": "A leading technology company.",
        "groups": [
          {
            "id": "grp_5fa60242-0756-4e31-8cca-30c2c5ff1ac2",
            "name": "Engineering"
          }
        ],
        "addresses": [
          "123 Main St, Springfield, USA",
          "456 Main St, Springfield, USA"
        ],
        "emails": [
          "john@example.com",
          "john@techcorp.com"
        ],
        "phones": [
          "+1234567890",
          "+0987654321"
        ],
        "urls": [
          "https://example.com"
        ],
        "customFieldValues": {
          "grp_5fa60242-0756-4e31-8cca-30c2c5ff1ac2": {
            "Status": "Active",
            "Business type": [
              "B2B",
              "B2C"
            ],
            "Join date": "2021-01-01",
            "Relationships": [
              {
                "id": "per_ed110a47-5d09-43bf-b2e2-791d8231eb5f",
                "fullName": "Bob Smith",
                "entityType": "person"
              },
              {
                "id": "com_9a03f575-8a85-40b0-ba2e-16d8e29e3b03",
                "fullName": "HR services",
                "entityType": "company"
              }
            ]
          },
          "grp_acdf2ad9-6a66-4d32-8594-9694913ac717": {
            "Custom Notes": "Important client, handle with care.",
            "ARR": "42000000",
            "Assignee": [
              {
                "id": "usr_c3606e3b-0a92-4849-90e5-88a8d3f388d6",
                "fullName": "Jane Doe",
                "email": "jane@example.com"
              }
            ]
          }
        }
      }
    ],
    "pagination": {
      "nextLink": "https://api.folk.app/v1/companies?limit=20&cursor=eyJvZmZzZXQiOjIwfQ%3D%3D"
    }
  }
}

Authorizations

​
Authorization
string
header
required

API key for authentication

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 length: 128
​
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 companies in the workspace.

The response is of type object.