Look up an invitation

const options = {method: 'GET'};

fetch('http://{defaultHost}/api/v3/seller/auth/invitations/{id}/lookup', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "id": "inv_UkLWZg9DAJ",
  "email": "newcomer@acme.test",
  "created_at": "2026-01-15T12:00:00.000Z",
  "expires_at": "2026-01-29T12:00:00.000Z",
  "accepted_at": null,
  "status": "pending",
  "acceptance_url": "/accept-invitation/inv_UkLWZg9DAJ?token=RgGhNP1euUCS75Nc3V1Y7YQF"
}

{
  "error": {
    "code": "record_not_found",
    "message": "Invitation not found, expired, or already accepted."
  }
}

Look up an invitation

Reads an invitation from the emailed link, before anyone signs in.

The acceptance page needs the invited address to decide whether it is asking someone to set a new password or to confirm one they already have.

Unauthenticated — the ID and token in the emailed link are the credential. A wrong token is indistinguishable from an unknown invitation: both answer 404, so the endpoint cannot be used to enumerate. An invitation onto the store’s own staff rather than a seller answers 404 here too.

GET

api

seller

auth

invitations

{id}

lookup

Look up an invitation

const options = {method: 'GET'};

fetch('http://{defaultHost}/api/v3/seller/auth/invitations/{id}/lookup', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "id": "inv_UkLWZg9DAJ",
  "email": "newcomer@acme.test",
  "created_at": "2026-01-15T12:00:00.000Z",
  "expires_at": "2026-01-29T12:00:00.000Z",
  "accepted_at": null,
  "status": "pending",
  "acceptance_url": "/accept-invitation/inv_UkLWZg9DAJ?token=RgGhNP1euUCS75Nc3V1Y7YQF"
}

{
  "error": {
    "code": "record_not_found",
    "message": "Invitation not found, expired, or already accepted."
  }
}

Path Parameters

string

required

Invitation ID from the emailed link

Query Parameters

token

string

required

The token from the emailed link

Response

invitation found

string

required

string

required

created_at

string

required

expires_at

string | null

required

accepted_at

string | null

required

status

required

The values listed are the built-in ones; extensions may add more.

Available options:

pending,

accepted

acceptance_url

string

required

⌘I

API basics

Endpoints

Look up an invitation

Path Parameters

Query Parameters

Response