List an Organization's Members

View .md OpenAPI spec Open in Claude Open in ChatGPT

GET

/v1/organizations/{id}/members

const url = 'https://app.caprid.com/v1/organizations/4/members';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

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/organizations/4/members \
  --header 'Authorization: Bearer <token>'

Everyone who belongs to the Organization, with their role and when they joined, longest-standing first. Any Member can list them, and so can the Organization’s API keys.

Authorizations

Parameters

Path Parameters

required

integer

The Organization’s id, from GET /v1/organizations.

Example

Responses

200

The Members.

application/json

Array<object>

An Account that belongs to an Organization.

object

account_id

required

Identifies the Member in routes.

integer

email

required

string

role

required

Every Member manages everything the Organization owns. An Owner can also manage its Members and Invitations.

string

Allowed values: owner member

joined_at

required

When the Account became a Member.

integer

Example

[
  {
    "account_id": 7,
    "email": "bob@acme.example",
    "role": "owner",
    "joined_at": 1790294400
  },
  {
    "account_id": 12,
    "email": "alice@acme.example",
    "role": "member",
    "joined_at": 1790380800
  }
]

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 limited to some Namespaces, to a Namespace outside its limit, or to a route that acts on the Organization as a whole. A limited key can never create API keys.

application/json

object

error

required

string

Example

{
  "error": "this API key is limited to the Namespaces acme-staging, and acme isn't one of them"
}

404

No such thing, or not yours. Another customer’s Organization or Namespace is a 404 too, so nobody can tell which ones exist.

application/json

object

error

required

string

Example

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