Invitations

List invitations

GET/v1/workspaces/{workspaceId}/invitations

Lists pending invitations for the workspace. Requires an admin key.

Authentication

Send your Spark API key with every request. The value is the full bearer token Spark returned when you created the key. See Authentication.

Authorization: Bearer <SPARK_API_KEY>

Path parameters

workspaceId

string

The workspace id.

Was this page helpful?

curl \
  --url "https://api.spark.graphon.ai/v1/workspaces/wspQ7WsH2Np5L/invitations" \
  --header "Authorization: Bearer $SPARK_API_KEY"

Response

JSON

{
  "items": [
    {
      "id": "invC3d4E5f6G7",
      "workspaceId": "wspQ7WsH2Np5L",
      "email": "grace@example.com",
      "role": "editor",
      "state": "pending",
      "delivery": "queued",
      "expiresAt": "2026-09-21T18:00:00.000Z",
      "revision": 1
    }
  ]
}