List organization invites | Sample

2 parameters

limitintegeroptional

The maximum number of invite objects to return, from 1 to 100. Defaults to 20 when omitted.

Default:20

afterstringoptional

A cursor containing an invite object ID that marks the starting position for the next page.

1 status code

200Returns a list object containing invite data, the first and last invite IDs, and a `has_more` value indicating whether additional results are available.

objectstringrequired

The object type, which is always `list`

Allowed:list

dataarray<object>required

first_idstringoptional

The first `invite_id` in the retrieved `list`

last_idstringoptional

The last `invite_id` in the retrieved `list`

has_morebooleanrequired

The `has_more` property is used for pagination to indicate there are additional results.

Error handling

limit must be between 1 and 100 when provided and defaults to 20 when omitted. Use after as an invite object ID from the previous page to retrieve subsequent results.

import { Client } from "acme-sdk";

const client = new Client({
  baseUrl: "https://api.acme.com",
  auth: { bearer: process.env.API_TOKEN },
  retry: {
    maxAttempts: 3,
    retryOn: [
      408,
      425,
      429,
      500,
      502,
      503,
      504,
    ],
    backoffMs: 500,
    maxBackoffMs: 8000,
  },
  timeoutMs: 30000,
});

const result = await client.invites.list({
  limit: 20,
  after: "example",
});

{
  "object": "list",
  "data": [
    {
      "object": "organization.invite",
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "email": "user@example.com",
      "role": "owner",
      "status": "accepted",
      "created_at": 1,
      "expires_at": 1,
      "accepted_at": 1,
      "projects": [
        {
          "id": "550e8400-e29b-41d4-a716-446655440000",
          "role": "member"
        }
      ]
    }
  ],
  "first_id": "550e8400-e29b-41d4-a716-446655440000",
  "last_id": "550e8400-e29b-41d4-a716-446655440000",
  "has_more": true
}

Request

Response

Errors