Skip to main content
GET
/
api
/
v3
/
admin
/
invitations
Spree Admin SDK
import { createAdminClient } from '@spree/admin-sdk'

const client = createAdminClient({
  baseUrl: 'https://your-store.com',
  secretKey: 'sk_xxx',
})

const { data: invitations } = await client.invitations.list()
{
  "data": [
    {
      "id": "inv_UkLWZg9DAJ",
      "email": "jessica_reichel@greenfelder.name",
      "status": "pending",
      "created_at": "2026-06-01T13:01:06.738Z",
      "updated_at": "2026-06-01T13:01:06.738Z",
      "expires_at": "2026-06-15T13:01:06.736Z",
      "role_id": "role_UkLWZg9DAJ",
      "role_name": "admin",
      "inviter_email": "keri@durganhuels.biz",
      "acceptance_url": "/accept-invitation/inv_UkLWZg9DAJ?token=HxZc9HRnCkEx5idyM3ALMnpK",
      "invitee_exists": false,
      "store": {
        "id": "store_UkLWZg9DAJ",
        "name": "Spree Test Store"
      }
    }
  ],
  "meta": {
    "page": 1,
    "limit": 25,
    "count": 1,
    "pages": 1,
    "from": 1,
    "to": 1,
    "in": 1,
    "previous": null,
    "next": null
  }
}

Authorizations

x-spree-api-key
string
header
required

Secret API key for admin access

Authorization
string
header
required

JWT token for admin user authentication

Headers

x-spree-api-key
string
required
Authorization
string
required

Response

200 - application/json

invitations found