---
title: "Retrieve an account invitation"
method: GET
path: "/accounts/{account}/invitations/{invitation}"
tags: ["Account"]
---

# Retrieve an account invitation

`GET /accounts/{account}/invitations/{invitation}`

## Request

- Base URL: `https://api.factuarea.com/v1`
- URL: `https://api.factuarea.com/v1/accounts/{account}/invitations/{invitation}`
- Auth: one of:
  - HTTP bearer
  - API key in header `X-API-Key`

Retrieve one invitation by its `id` (UUID v7): `email`, `role`, initial `grants[]`, `send_email`, `external_advisor`, `status` and `expires_at`.
- Grants shown are only those on tax IDs your credential reads.
- The acceptance secret and URL are never returned here.
- An unknown, malformed or foreign invitation returns the same 404 `invitation_not_found`. Requires the `invitations:read` scope, which `*` does not cover: the API key must list it explicitly.

## Path parameters

- `account` string, uuid, required
- `invitation` string, uuid, required

## Headers

- `Factuarea-Version` string, date

## Response `200`

- object
  - `data` AccountInvitation, required: An invitation to join your ACCOUNT with an account role and its initial grants. The acceptance secret is never part of this representation: publishing it would turn a read permission into an effective power to add members, and one that would survive revoking the credential.
    - `id` string, uuid, required: Opaque identifier of the invitation, a UUID v7.
    - `object` 'account_invitation', required: Always `account_invitation`.
    - `email` string, email, required: Address the invitation was sent to.
    - `role` 'admin' | 'member', required: Account role the person would join with. `owner` never appears: ownership is transferred, never handed out by invitation.
    - `grants` object[], required: Initial per-tax-ID grants of a `member` invitation, limited to the tax IDs your credential reads. Always empty for an `admin`.
      - `object` 'account_member_grant', required: Always `account_member_grant`.
      - `company_id` string, uuid, required: Opaque identifier (UUID v7) of the tax ID of the account the grant applies to.
      - `level` 'view' | 'operate', required: Access level on that tax ID: `view` is read-only, `operate` can also write.
    - `send_email` boolean, required: Whether the invitation was delivered by email (`false`: the link was copied and delivered by whoever invited).
    - `external_advisor` boolean, required: Whether this is the invitation of the external advisor of the account (only created from the web app).
    - `status` 'pending' | 'accepted' | 'revoked' | 'expired', required: Derived state. `accepted` and `revoked` are final; `expired` only applies to an invitation that was still pending when its expiry passed.
    - `expires_at` string, date-time, required: Expiry instant (ISO 8601).
    - `created_at` string, date-time, nullable, required: Instant (ISO 8601) the invitation was created, or `null` when it is not known.
    - `sent_at` string, date-time, nullable, required: Instant (ISO 8601) of the last send: the creation or the last resend. `null` when it is not known.
    - `invited_by` object, nullable, required: The person who created the invitation. `null` when that person no longer belongs to the account.
      - `id` string, uuid, required: Opaque identifier (UUID v7) of the person.
      - `name` string, required: Full name of the person.

## Other responses

- `400`: `parameter_unknown` with `subcode` `retired_active_profile_header`: the retired `X-Active-Profile` header was sent; the company goes in the path. `parameter_invalid_format` on `Factuarea-Version`: the header is not a `YYYY-MM-DD` date. `unsupported_api_version`: the `Factuarea-Version` date is not a supported version.
- `401`: Missing or invalid API key.
- `403`: The request is authenticated but not allowed: the API key lacks the required scope (`insufficient_scope`), the plan does not include the public API or this feature (`addon_not_active`, `feature_not_available_in_plan`), or the module is not available with a test key (`module_not_available_in_sandbox`).
- `404`: The requested resource does not exist or belongs to another company. `account_not_found`: the account in the path does not exist or is not the account of the API key.
- `429`: Rate limit exceeded. Retry after the duration in `Retry-After`.
- `500`: Unexpected server error.

---

[API](https://skmtc.dev/factuarea/apis/factuarea-public-api.md) · [All operations](https://skmtc.dev/factuarea/apis/factuarea-public-api/llms.txt) · [OpenAPI document](https://skmtc.dev/factuarea/apis/factuarea-public-api/revisions/718e77934422?raw)