# invitation

Represents an invitation sent to a user to join an organization. Contains all details about the invitation including who sent it, who will receive it, and its validity period.

### Examples

```graphql
type Invitation {
  id: String
  inviteeEmail: String
  invitation_url: String
  created_at: String
  expires_at: String
}
```

### Fields

| Field                    | Description                                                    | Supported fields |
| ------------------------ | -------------------------------------------------------------- | ---------------- |
| id `String`              | Unique identifier for the invitation                           |                  |
| inviteeEmail `String`    | Email address of the person receiving the invitation           |                  |
| invitation\_url `String` | Complete URL that the invitee can use to accept the invitation |                  |
| created\_at `String`     | Timestamp when this invitation was created, in ISO 8601 format |                  |
| expires\_at `String`     | Timestamp when this invitation will expire, in ISO 8601 format |                  |

### References

#### Queries using this object:

* [\<?> getInvitations](/api-documentation/api-reference/api--organization/queries/get-invitations.md)

#### Mutations using this object:

* [<\~> createInvitation](/api-documentation/api-reference/api--organization/mutations/create-invitation.md)
* [<\~> createMultipleInvitations](/api-documentation/api-reference/api--organization/mutations/create-multiple-invitations.md)
* [<\~> resendInvitation](/api-documentation/api-reference/api--organization/mutations/resend-invitation.md)


---

# Agent Instructions: Querying This Documentation

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

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.ox.security/api-documentation/api-reference/api--organization/types/objects/invitation.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
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.
