List the Invitations to your email

View .md OpenAPI spec Open in Claude Open in ChatGPT

GET

/v1/invitations

const url = 'https://app.caprid.com/v1/invitations';
const options = {
  method: 'GET',
  headers: {cookie: '__Host-switchboard_session=<__Host-switchboard_session>'}
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://app.caprid.com/v1/invitations \
  --cookie __Host-switchboard_session=<__Host-switchboard_session>

Only with WorkOS login, which has verified your email. Lists the pending Invitations to it, from every Organization, so you can accept one without its link. The dashboard shows them when you sign up.

Authorizations

session

Responses

200

The pending Invitations to your email.

application/json

Array<object>

An offer of membership in an Organization to one email address.

object

required

Identifies the Invitation in routes. Not a secret.

string

organization_id

required

integer

organization_name

The Organization’s name, for someone who isn’t in it yet.

string

email

required

Who may accept it. Stored lowercased.

string

role

required

The role they’ll have once they accept.

string

Allowed values: owner member

created_at

required

integer

expires_at

required

When the link stops working, 7 days after it was created.

integer

Example

[
  {
    "id": "3f9c1a2b7d4e",
    "organization_id": 4,
    "organization_name": "Acme",
    "email": "alice@acme.example",
    "role": "member",
    "created_at": 1790294400,
    "expires_at": 1790899200
  }
]

401

No valid credential. Missing, expired and revoked credentials all get the same response, and so does an API key whose trial has lapsed. An Agent token from before a claim gets a 401 too, once the claim has made the trial a person’s, with a message saying to get a new token.

application/json

object

error

required

string

Example

{
  "error": "the requested grants exceed the key's scope"
}

Headers

WWW-Authenticate

string

Example

Bearer realm="switchboard"

403

Sent with an API key, or with a session whose email WorkOS hasn’t verified.

application/json

object

error

required

string

Example

{
  "error": "the requested grants exceed the key's scope"
}

404

This server doesn’t use WorkOS login.

application/json

object

error

required

string

Example

{
  "error": "the requested grants exceed the key's scope"
}