folk tools
The 13 folk operations your product runs on your customer's account through Connect. All of them use the same endpoint, POST /api/tools/{tool}/execute.
- 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.
- List peopleGETLists 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.
- 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.
- Create objectPOSTCreates a deal, or an object of another type, in a group. Linked people and companies must already be in the group, or folk ignores them. An unknown custom field name fails the whole request with 422.
- Update objectPATCHUpdates a deal or another object, changing only the fields sent. people and companies replace the current lists, so send them whole. Moving a deal in the pipeline is a change of its Status custom field.
- List notesGETLists the notes of the workspace with content, visibility, author, creation date and the person, company or object each one belongs to. query searches the content. The next page comes from the cursor inside pagination.nextLink; the last page has no nextLink.
- Create notePOSTAdds a note to a person, a company or an object such as a deal. The content accepts Markdown.
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.
