> ## Documentation Index
> Fetch the complete documentation index at: https://developers.conveyour.com/llms.txt
> Use this file to discover all available pages before exploring further.
# Overview
> The people in your account, and everything attached to them.
Contacts are the people your account is about, and this section covers them plus everything that hangs off a person — their fields, the groups they belong to, the notes and tasks recorded against them, the links shown on their profile, and their activity history. It exists because a contact is the anchor for nearly everything else in ConveYour: messages, lessons and automations are all ultimately aimed at one.
## Contacts
A contact is a person in your account — whatever your team calls them. Recruits, onboardees, candidates, reps, trainees, employees: they all store the same way, so the label you use doesn't change how the API works. Contacts exist because everything else in ConveYour attaches to a person; a message, a lesson or a task is only meaningful once it points at one. See [An Overview of Contacts](https://conveyour.com/help/contacts-an-overview) in the Help Center.
| Method | Endpoint | What it does |
| - | - | - |
| `GET` | [`/api/contacts`](/api-reference/contacts/list-contacts) | List contacts |
| `GET` | [`/api/contacts/{id}`](/api-reference/contacts/get-a-contact) | Get a contact |
| `POST` | [`/api/contacts`](/api-reference/contacts/create-a-contact) | Create a contact |
| `PUT` | [`/api/contacts/{id}`](/api-reference/contacts/update-a-contact) | Update a contact |
| `DELETE` | [`/api/contacts/{id}`](/api-reference/contacts/delete-a-contact) | Delete a contact |
| `POST` | [`/api/contacts/block`](/api-reference/contacts/block-a-contact) | Block a contact |
| `POST` | [`/api/contacts/merge`](/api-reference/contacts/merge-two-contacts) | Merge two contacts |
| `POST` | [`/api/contacts/resolve`](/api-reference/contacts/resolve-contact-ids) | Resolve contact IDs |
| `POST` | [`/api/contacts/unblock`](/api-reference/contacts/unblock-a-contact) | Unblock a contact |
| `GET` | [`/api/contacts/{id}/reveal-secret`](/api-reference/contacts/reveal-a-secret-field) | Reveal a secret field |
| `POST` | [`/api/contacts/compile/{id}`](/api-reference/contacts/compile-content-for-a-contact) | Compile content for a contact |
| `POST` | [`/api/contacts/{id}/archive`](/api-reference/contacts/archive-a-contact) | Archive a contact |
| `POST` | [`/api/contacts/{id}/unarchive`](/api-reference/contacts/unarchive-a-contact) | Unarchive a contact |
## Fields
Fields are the custom attributes you define on a contact, on top of the built-ins like first name, last name, email and mobile. Each has a display **label** and a machine **name** — the key it appears under in a contact record, and the one you use in the API and in automations. A field is typed: `string`, `int`, `bool`, `date`, `time`, `email`, `textarea`, `list`, `image`, `id_number`, `user_list`, `relation`, `related_contacts` or `related_custom_object`. They exist so you can store whatever your process actually needs on a profile — a start date, a crew role, a certification expiry — without waiting for it to become a built-in. See [Contact Fields](https://conveyour.com/help/creating-custom-fields) in the Help Center.
| Method | Endpoint | What it does |
| - | - | - |
| `GET` | [`/api/fields`](/api-reference/fields/list-fields) | List fields |
| `GET` | [`/api/fields/{id}`](/api-reference/fields/get-a-field) | Get a field |
| `POST` | [`/api/fields`](/api-reference/fields/create-a-field) | Create a field |
| `PUT` | [`/api/fields/{id}`](/api-reference/fields/update-a-field) | Update a field |
| `DELETE` | [`/api/fields/{id}`](/api-reference/fields/delete-a-field) | Delete a field |
| `POST` | [`/api/fields/validate`](/api-reference/fields/validate-a-field) | Validate a field |
## Groups (Bookmarks)
A group is a saved search over your contact roster: a reusable filter that resolves to a set of contacts, and re-resolves automatically as contacts start or stop matching it. Groups exist so you can name a segment once and keep using it — to target messages, drive automations, or scope a report — instead of rebuilding the same query each time. The API calls them `bookmarks`. See [Groups Introduction](https://conveyour.com/help/groups-an-introduction) in the Help Center.
| Method | Endpoint | What it does |
| - | - | - |
| `GET` | [`/api/bookmarks`](/api-reference/groups-bookmarks/list-groups) | List groups |
| `GET` | [`/api/bookmarks/{id}`](/api-reference/groups-bookmarks/get-a-group) | Get a group |
| `POST` | [`/api/bookmarks`](/api-reference/groups-bookmarks/create-a-group) | Create a group |
| `PUT` | [`/api/bookmarks/{id}`](/api-reference/groups-bookmarks/update-a-group) | Update a group |
| `DELETE` | [`/api/bookmarks/{id}`](/api-reference/groups-bookmarks/delete-a-group) | Delete a group |
| `GET` | [`/api/bookmarks/folders`](/api-reference/groups-bookmarks/list-folders) | List folders |
| `GET` | [`/api/bookmarks/search`](/api-reference/groups-bookmarks/search-groups) | Search groups |
| `POST` | [`/api/bookmarks/folders`](/api-reference/groups-bookmarks/create-a-folder) | Create a folder |
| `POST` | [`/api/bookmarks/order`](/api-reference/groups-bookmarks/reorder-groups) | Reorder groups |
| `GET` | [`/api/bookmarks/folders/{id}`](/api-reference/groups-bookmarks/get-a-folder) | Get a folder |
| `GET` | [`/api/bookmarks/{id}/from_contact`](/api-reference/groups-bookmarks/get-groups-for-a-contact) | Get groups for a contact |
| `PUT` | [`/api/bookmarks/folders/{id}`](/api-reference/groups-bookmarks/update-a-folder) | Update a folder |
| `DELETE` | [`/api/bookmarks/folders/{id}`](/api-reference/groups-bookmarks/delete-a-folder) | Delete a folder |
## Notes
Notes are internal commentary recorded against a contact, supporting @-mentions, pinning and team-scoped visibility. Mentioning a teammate emails them a link straight back to the contact's notes. They exist so the context behind a person travels with them, and so one person's knowledge is available to whoever works that contact next. See [Contact Notes](https://conveyour.com/help/contacts-notes) in the Help Center.
| Method | Endpoint | What it does |
| - | - | - |
| `GET` | [`/api/notes`](/api-reference/notes/list-notes) | List notes |
| `POST` | [`/api/notes`](/api-reference/notes/create-a-note) | Create a note |
| `PUT` | [`/api/notes/{id}`](/api-reference/notes/update-a-note) | Update a note |
| `DELETE` | [`/api/notes/{id}`](/api-reference/notes/delete-a-note) | Delete a note |
## Tasks
Contact tasks are to-dos attached to a specific person, with a due date and assigned users. They exist to track the follow-up work a contact needs, on the contact's own record rather than in a separate tool. Distinct from the team task board under Content. See [Tasks Assigned to Contacts](https://conveyour.com/help/contacts-tasks-assigned-to-contacts) in the Help Center.
| Method | Endpoint | What it does |
| - | - | - |
| `GET` | [`/api/contacts/tasks`](/api-reference/tasks/list-contact-tasks) | List contact tasks |
| `POST` | [`/api/contacts/tasks`](/api-reference/tasks/create-a-contact-task) | Create a contact task |
| `PUT` | [`/api/contacts/tasks/{id}`](/api-reference/tasks/update-a-contact-task) | Update a contact task |
| `DELETE` | [`/api/contacts/tasks/{id}`](/api-reference/tasks/delete-a-contact-task) | Delete a contact task |
## Links
Links are reusable URL records defined once for your organization — a title plus a URL that may contain `{{field}}` placeholders. Each is compiled against a contact's own data and appears as a clickable action on that contact's profile, so one definition sends every person to their own destination. They exist so you register a link once rather than storing a separate URL on every contact.
| Method | Endpoint | What it does |
| - | - | - |
| `GET` | [`/api/urls`](/api-reference/links/list-links) | List links |
| `POST` | [`/api/urls`](/api-reference/links/create-a-link) | Create a link |
| `PUT` | [`/api/urls/{id}`](/api-reference/links/update-a-link) | Update a link |
| `DELETE` | [`/api/urls/{id}`](/api-reference/links/delete-a-link) | Delete a link |
## Activity
Activity is the event feed for a contact: a paginated, timestamp-ordered record of what has happened to them, and the same timeline shown on the right of their profile. It exists to answer "what has this person actually done, and when" without reconstructing it from separate endpoints. See [The Activity Feed](https://conveyour.com/help/contacts-the-activity-feed) in the Help Center.
| Method | Endpoint | What it does |
| - | - | - |
| `GET` | [`/api/schedule`](/api-reference/schedule/list-activity) | List activity |
| `GET` | [`/api/schedule/{id}`](/api-reference/schedule/get-an-activity-entry) | Get an activity entry |
| `GET` | [`/metrics/export`](/api-reference/schedule/export-activity) | Export activity |
This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.