# Mintlify Starter Kit

- [Introduction](https://docs.vegaminds.com/index.md): Welcome to your project
- [Quickstart](https://docs.vegaminds.com/quickstart.md): Begin with a guide on the fastest path to a successful outcome
- [Connect a user](https://docs.vegaminds.com/api-reference/authorization/authorize.md): Not called by your server: send the user's browser here to start a connection, as in step 1 of the authorization guide. Vega shows its login and consent screen, then redirects the browser to your `redirect_uri`.
- [Get tokens](https://docs.vegaminds.com/api-reference/authorization/token.md): Exchanges an authorization code for tokens, or a refresh token for new tokens. Your application authenticates with HTTP Basic, `client_id` as the user name and `client_secret` as the password, or with `client_id` and `client_secret` in the form.
- [Revoke a token](https://docs.vegaminds.com/api-reference/authorization/revoke.md): Revoking a refresh token ends the connection, and its access tokens stop working. Revoking an access token ends that token only. Answers `200` for a token that is unknown or already revoked (RFC 7009). The client authenticates as for `POST /oauth/token`.
- [Get the connected user](https://docs.vegaminds.com/api-reference/me/get-me.md): The user the access token acts for, their firm, and the scopes they granted. Needs no scope.
- [List users](https://docs.vegaminds.com/api-reference/users/list-users.md): The active users of the connected user's firm, by last name and then first name. A user's `id` is what a task takes as `assignee_id`.
- [List contacts](https://docs.vegaminds.com/api-reference/contacts/list-contacts.md): The contacts the user can see, by last name and then first name. With `query`, the closest matches come first. Rows are summaries; get a contact for its emails, phone numbers and addresses.
- [Create a contact](https://docs.vegaminds.com/api-reference/contacts/create-contact.md): Creates a contact owned by the connected user. It needs a first name or a last name.
- [Get a contact](https://docs.vegaminds.com/api-reference/contacts/get-contact.md)
- [Delete a contact](https://docs.vegaminds.com/api-reference/contacts/delete-contact.md)
- [Update a contact](https://docs.vegaminds.com/api-reference/contacts/update-contact.md): A field left out is unchanged, and `null` clears it. A list sent replaces the whole list, and `[]` empties it. The contact keeps a first name or a last name.
- [List contact types](https://docs.vegaminds.com/api-reference/contacts/list-contact-types.md): The firm's contact types, in the order Vega shows them. A contact's `contact_type` takes a `value`.
- [List households](https://docs.vegaminds.com/api-reference/households/list-households.md): The households the user can see, by name. With `query`, the closest matches come first.
- [Create a household](https://docs.vegaminds.com/api-reference/households/create-household.md): Creates a household owned by the connected user, with its members. Members are set here only; they are changed later in Vega.
- [Get a household](https://docs.vegaminds.com/api-reference/households/get-household.md)
- [Delete a household](https://docs.vegaminds.com/api-reference/households/delete-household.md): Deletes the household. Its members stay, as contacts.
- [Update a household](https://docs.vegaminds.com/api-reference/households/update-household.md): A field left out is unchanged. Members are changed in Vega.
- [List household types](https://docs.vegaminds.com/api-reference/households/list-household-types.md): The firm's household types, in the order Vega shows them. A household's `household_type` takes a `value`.
- [List notes](https://docs.vegaminds.com/api-reference/notes/list-notes.md): The notes the user can see, most recently updated first. With `query`, notes whose title has every word come first. Rows are summaries; get a note for its body.
- [Create a note](https://docs.vegaminds.com/api-reference/notes/create-note.md): Creates a note owned by the connected user, linked to the given contacts and households. Links are set here only; they are changed later in Vega.
- [Get a note](https://docs.vegaminds.com/api-reference/notes/get-note.md)
- [Delete a note](https://docs.vegaminds.com/api-reference/notes/delete-note.md)
- [Update a note](https://docs.vegaminds.com/api-reference/notes/update-note.md): A field left out is unchanged. Linked clients are changed in Vega.
- [List meetings](https://docs.vegaminds.com/api-reference/meetings/list-meetings.md): The meetings the connected user can see. List rows omit artifact bodies, email drafts, transcripts and recording URLs. There is no updated_after filter: artifact edits do not reliably advance the meeting timestamp. Re-read relevant meetings to refresh their artifacts.
- [Create a meeting](https://docs.vegaminds.com/api-reference/meetings/create-meeting.md): Create a Vega meeting with the connected user as owner and creator, using their default sharing. Requires topic, start_time and duration_minutes. Optional client ids must all be accessible and are set at creation only. This does not create a calendar event, invite attendees, attach recordings, uploa…
- [Get a meeting](https://docs.vegaminds.com/api-reference/meetings/get-meeting.md): Read a meeting with its latest preparation and pre-meeting email draft, latest note and follow-up email draft, full transcript, and recording read URLs. Missing artifacts and recordings are null. Analytics, artifact history, upload capabilities and generation or sending operations are not exposed. R…
- [Delete a meeting](https://docs.vegaminds.com/api-reference/meetings/delete-meeting.md): Soft-delete a visible Vega meeting. A linked meeting (is_external true) returns 409 external_record; delete it in its source application. This does not cancel a calendar event, delete external content or erase recording files. A missing, inaccessible or already deleted meeting returns 404. No artifa…
- [Update a meeting](https://docs.vegaminds.com/api-reference/meetings/update-meeting.md): Patch only the supplied fields. Topic, start_time, duration_minutes and reviewed cannot be null; format and join_url can be cleared. If is_external is true, only reviewed may be supplied. A mixed patch is refused in full with 409 external_record, even when protected values are unchanged. Description…
- [List tasks](https://docs.vegaminds.com/api-reference/tasks/list-tasks.md): The tasks the user can see, latest due date first. Tasks synced from another CRM without a due date come before the others. Rows are summaries; get a task for its description.
- [Create a task](https://docs.vegaminds.com/api-reference/tasks/create-task.md): Creates a task owned by the connected user, starting as `not_started`. An assignee other than the connected user is notified in Vega and by email. Linked clients are set here only; they are changed later in Vega.
- [Get a task](https://docs.vegaminds.com/api-reference/tasks/get-task.md)
- [Delete a task](https://docs.vegaminds.com/api-reference/tasks/delete-task.md): Deletes the task. For a task that repeats, the other occurrences stay.
- [Update a task](https://docs.vegaminds.com/api-reference/tasks/update-task.md): A field left out is unchanged, and `null` clears it where allowed. A new assignee other than the connected user is notified in Vega and by email. Setting `status` to `completed` sets `completed_on`; another status clears it. A change to a task that repeats applies to that task alone.
- [List usable workflow templates](https://docs.vegaminds.com/api-reference/workflows/list-workflow-templates.md): Read-only templates the connected user can use, admins included. Ordered by name then id. Templates are created and edited in Vega.
- [Get a usable workflow template](https://docs.vegaminds.com/api-reference/workflows/get-workflow-template.md): Returns the roles and ordered stages needed to start a run. A default user may have left the firm; supply an active replacement in role_users.
- [List workflows](https://docs.vegaminds.com/api-reference/workflows/list-workflows.md): Accessible runs, newest created first, then id descending. Includes all statuses by default. Filter by contact_id or household_id, not both. A contact includes its households; a household includes its member contacts. This list does not support updated_after.
- [Start a workflow](https://docs.vegaminds.com/api-reference/workflows/create-workflow.md): Starts immediately from an accessible template, owned by the connected user with their default sharing. Copies the template and creates its first-stage tasks with the usual assignment and workflow-start notifications. Roles default to the template people; all must be active firm users. Client links…
- [Get a workflow](https://docs.vegaminds.com/api-reference/workflows/get-workflow.md): Returns its current stage, roles, ordered frozen stages, progress and accessible tasks. Use stages from this run, not the live template, when moving it.
- [Update a workflow name, tags or roles](https://docs.vegaminds.com/api-reference/workflows/update-workflow.md): Only name, tag_ids and role_users may change. A role update is partial and affects tasks created later, not existing task assignees. Status, stage, client links, scheduling, sharing and the frozen definition cannot be patched here.
- [Move a workflow to a stage](https://docs.vegaminds.com/api-reference/workflows/move-workflow.md): Moves an active run to stage_id from its frozen stages. Requires from_stage_id from the last read. A stale stage or concurrent move returns 409 conflict: read the run again before deciding whether to retry. Destination tasks are created when that stage has no remaining tasks, including when its prev…
- [List opportunity pipelines](https://docs.vegaminds.com/api-reference/opportunities/list-opportunity-pipelines.md): The firm's live pipelines, oldest first then id, with stages in board order. All users of the firm can discover them. Pipeline and stage definitions are managed in Vega.
- [Get an opportunity pipeline](https://docs.vegaminds.com/api-reference/opportunities/get-opportunity-pipeline.md): Returns the pipeline and its current ordered stages. A deleted pipeline or one belonging to another firm answers 404.
- [List opportunities](https://docs.vegaminds.com/api-reference/opportunities/list-opportunities.md): Accessible opportunities, most recently updated first, then id descending. Includes open, won and lost by default. Filter by contact_id or household_id, not both. A contact includes its households; a household includes its members. No updated_after filter. Descriptions are returned by the detail cal…
- [Create an opportunity](https://docs.vegaminds.com/api-reference/opportunities/create-opportunity.md): Requires a name and pipeline_id. The stage defaults to the pipeline's first stage, status to open, assignee to the connected user, and ownership and sharing to that user's defaults. Client links are optional and must be accessible. Won or lost opportunities receive a close date if omitted. Each call…
- [Get an opportunity](https://docs.vegaminds.com/api-reference/opportunities/get-opportunity.md): Includes its description, current pipeline and stage, status, amount, dates, assignee and accessible client links. A removed stage keeps its id and has a null stage_name.
- [Update an opportunity](https://docs.vegaminds.com/api-reference/opportunities/update-opportunity.md): Change its fields, move it with stage_id, change pipeline, or set status to won, lost or open. Moving creates no tasks and needs no from_stage_id: last write wins. A pipeline change takes its first stage unless stage_id is given. A removed stage can remain during unrelated edits but cannot be moved…
- [List tags](https://docs.vegaminds.com/api-reference/tags/list-tags.md): Active tags in the connected user's firm, ordered by name then id. Any firm user may read the catalog.
- [Create a tag](https://docs.vegaminds.com/api-reference/tags/create-tag.md): Create a firm-wide tag definition. The connected user must currently be a firm admin. Does not assign it to any records.
- [Get a tag](https://docs.vegaminds.com/api-reference/tags/get-tag.md): An active tag in the connected user's firm. Deleted, missing and other-firm tags all return 404.
- [Delete a tag](https://docs.vegaminds.com/api-reference/tags/delete-tag.md): Soft-delete the firm-wide tag definition, hiding it from the catalog and all record tag lists. The records themselves remain. The connected user must currently be a firm admin.
- [Rename a tag](https://docs.vegaminds.com/api-reference/tags/update-tag.md): Rename a firm-wide tag definition. The connected user must currently be a firm admin. All tagged records will display the new name.

## OpenAPI Specs

- [openapi](/openapi.yaml)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.