List people with the folk API
Lists the people of the workspace with id, names, emails, phones, job title, companies, groups and custom field values. The next page comes from the cursor inside pagination.nextLink; the last page has no nextLink.
- Identifier
- folk_list_people
The request
POST https://connect.reportei.com/api/tools/folk_list_people/execute
Authorization: Bearer <merchant token>
x-customer-token: <customer token>
Content-Type: application/json
Accept: application/json
{
"customer_toolkit": "<connection UUID>",
"arguments": {
"limit": 1
}
}Your system sends your customer's connection id and the tool arguments. The headers are the same as the rest of the Connect API: your product's token and your customer's token.
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
| limit | integer | No | Results per page, up to 100. Defaults to 20. |
| cursor | string | No | The cursor value inside pagination.nextLink of the previous response, URL-decoded (%3D becomes =). Omit it on the first call. |
Supported connections
Your customer connects their folk account once, with one of the modes below. The same connection serves every tool of the toolkit.
API key
Your customer pastes the app's key on a Connect screen, or your system sends the key with POST /api/customer-toolkits, with no screen.
The response
On success, Connect preserves the app's response status and body. HTTP errors returned by the app use the {error, api_error} envelope; authentication or validation can fail before execution. The X-Toolkit-Execution-Id header identifies the recorded execution, available at GET /api/tools/executions/{uuid}.
Ready for AI agents
This tool's input is a JSON Schema, available at GET /api/tools/folk_list_people. It becomes your agent's tool definition with no conversion.
Other folk tools
- List groupsGETLists the groups of the workspace with id and name. Groups hold people, companies and deals. The next page comes from the cursor inside pagination.nextLink; the last page has no nextLink.
- List group custom fieldsGETLists the custom fields of a group for people, companies or one object type, with name, type and the options of select fields. On person or company, each field of type objectField is an object type of the group, like Deals, and its name is the objectType of the object tools.
- Create personPOSTCreates a person, optionally in groups and linked to companies. folk merges duplicates in the background, which can overwrite part of the data sent. A person in no group only shows up in the folk search.
- Update personPATCHUpdates a person, changing only the fields sent. A list (groups, companies, emails, phones, addresses, urls) replaces the current one, so send it whole. Leaving a group out removes the person from it, along with their custom field values in that group.
- List companiesGETLists the companies of the workspace with id, name, industry, emails, phones, URLs, groups and custom field values. The next page comes from the cursor inside pagination.nextLink; the last page has no nextLink.
- Create companyPOSTCreates a company, optionally in groups. Names are unique in the workspace: an existing name returns that company instead of creating another one. A company in no group only shows up in the folk search.
- Update companyPATCHUpdates a company, changing only the fields sent. A list (groups, emails, phones, addresses, urls) replaces the current one, so send it whole. Leaving a group out removes the company from it, along with its custom field values in that group. A name already used by another company fails.
- List objectsGETLists the deals, or the objects of another type, of a group, with id, name, linked people and companies and custom field values, like the deal Status. The next page comes from the cursor inside pagination.nextLink; the last page has no nextLink. An unknown objectType answers 404 with the object types of the group.
Toolkits in the same category
See all 100 toolkitsSee Connect applied to your product.
Try it for 15 days with no card, or walk our team through your use case.
