At a glance
- Availability: Experimental (how to enable).
- Auth: API key.
- Connection: The key comes from
FOLK_API_KEY. - Docs: https://developer.folk.app/api-reference/authentication
Credentials
Set these per environment. See Connect an integration.| Variable | Required | Description |
|---|---|---|
FOLK_API_KEY | Yes | folk API key (sent as Authorization: Bearer), generated in workspace settings → API Docs. |
Setup
- Create a folk workspace: Sign up at https://www.folk.app/ - the free plan is enough to test the API.
- Generate an API key: In folk, open workspace settings → API (https://app.folk.app/apps/contacts/network/settings/api-keys) and generate a new API key (keys start with ‘FOLK’).
- Set the environment variable: Add FOLK_API_KEY to your .env.
- Verify access: Run the List Groups tool, then List People.
- The API key is sent as Authorization: Bearer <key>
- List endpoints return { data: { items, pagination } } and paginate with limit/cursor; pass pagination.nextLink’s cursor to continue
- Rate limit headers (X-RateLimit-*) are returned on every response
Tools
| Tool | Access | Description |
|---|---|---|
| List People | Read | List people in the folk workspace with optional filters |
| Get Person | Read | Get details of a person in folk |
| Create Person | Write | Create a new person in folk |
| Update Person | Write | Update fields on an existing person in folk |
| List Companies | Read | List companies in the folk workspace |
| Create Company | Write | Create a new company in folk |
| List Groups | Read | List groups (pipelines/segments) in the folk workspace |
Example prompts
- List people in my folk workspace and find the one matching a given name or email.
- Create a new person in folk with their name, email, and job title.