> For the complete documentation index, see [llms.txt](https://help.mimeeq.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://help.mimeeq.com/api/invitations.md).

# Invitations

Invite people to join your Mimeeq account as Tier 1 users and manage pending invitations. Invitations connect a person to the account and specify the account roles they should receive.

Use this section when onboarding an account user. Choose role IDs from Roles, create the invitation with the person’s email, name and default language, then use Users once the person is available as an account user.

### What you can do

| Task                       | Reference                                                                             |
| -------------------------- | ------------------------------------------------------------------------------------- |
| Find available invitations | [List Invitations](https://help.mimeeq.com/developers/invitations/list-invitations)   |
| Add a new invitation       | [Create Invitation](https://help.mimeeq.com/developers/invitations/create-invitation) |
| Remove invitation          | [Delete Invitation](https://help.mimeeq.com/developers/invitations/delete-invitation) |

### Before you start

Your API key needs `invitations:read` to read these resources. Use `invitations:write` for write operations.

### Important behaviour

Creating an invitation can send an invitation email or assign an existing eligible user. The result may contain a null `invitationId` when there is no pending invitation to track. List Invitations is not cursor-paginated. Cancelling an invitation removes the pending invitation; it does not deactivate an existing user.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://help.mimeeq.com/api/invitations.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.