Account

Retrieve an account invitation

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.
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

Path parameters

accountstring uuid required

Public identifier (UUID v7) of your account. Get it from GET /v1/me (data.account.id).

invitationstring uuid required

Public identifier (UUID v7) of the account invitation.

Headers

Factuarea-Versionstring date
Example:2026-06-01

Pin the API version (YYYY-MM-DD, Stripe-style date versioning) for this request; omit to use the key's pinned version, or the latest if none. Unsupported version → 400 unsupported_api_version; malformed → 400 parameter_invalid_format. The effective version is echoed in the Factuarea-Version response header. See the Versioning guide.

Response

Example response

{
  "data": {
    "id": "01931b3e-7c4a-7f2e-9a8b-3c5d6e7f8c20",
    "email": "marta@acme.example",
    "grants": [
      {
        "company_id": "01931b3e-7c4a-7f2e-9a8b-3c5d6e7f8a01"
      }
    ],
    "send_email": true,
    "expires_at": "2026-10-03T09:15:00Z",
    "created_at": "2026-09-26T09:15:00Z",
    "sent_at": "2026-09-26T09:15:00Z",
    "invited_by": {
      "id": "01931b3e-7c4a-7f2e-9a8b-4d6e7f8a9b11",
      "name": "Marta Ibáñez"
    }
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.