GET
/
organizations
/
{id}
/
invitations
TypeScript
import Nuntly from '@nuntly/sdk';

const client = new Nuntly({
  apiKey: 'My API Key',
});

// Automatically fetches more pages as needed.
for await (const invitationListResponse of client.organizations.invitations.list('id')) {
  console.log(invitationListResponse.id);
}
{
  "data": [
    {
      "id": "invit_01jnxn8wd3gvcr98yscpctd9vw",
      "org_id": "org_01jh6jk82zjq9deye73h0mzcaq",
      "email": "sarah.connor@sky.net",
      "inviter_email": "ray@info.tomlinson.ai",
      "invitation_expired_at": "2025-01-16T22:22:41.247Z",
      "kind": "invitation",
      "status": "pending",
      "created_at": "2025-01-09T22:22:41.247Z",
      "modified_at": "2025-01-09T22:22:41.247Z",
      "region": "eu-west-1"
    }
  ],
  "next_cursor": "<string>"
}

Authorizations

Authorization
string
header
required

Bearer HTTP authentication. Allowed headers Authorization: Bearer <API_KEY>

Path Parameters

id
string
required

The organization id previously created

Query Parameters

status
enum<string>

The status of the invitation

Available options:
pending,
accepted,
declined,
done
limit
number
default:10

The number of emails to return

Required range: 1 <= x <= 30
cursor
string

The cursor to use for pagination

Response

200
application/json

A successful response

The response is of type object.