Skip to main content
GET
/
v1
/
regions
/
global
/
organizations
/
{orgId}
/
invitations
List invitations
const options = {method: 'GET'};

fetch('https://api.example.com/v1/regions/global/organizations/{orgId}/invitations', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
{
  "success": true,
  "data": [
    {
      "id": "<string>",
      "token": "<string>",
      "email": "jsmith@example.com",
      "projectId": "<string>",
      "organizationId": "<string>",
      "role": "admin",
      "status": "pending",
      "invitedBy": "<string>",
      "expiresAt": "2023-11-07T05:31:56Z",
      "createdAt": "2023-11-07T05:31:56Z",
      "acceptedAt": "2023-11-07T05:31:56Z"
    }
  ],
  "meta": {
    "total": 123
  }
}

Path Parameters

orgId
string
required

Organization identifier

Query Parameters

status
enum<string>

Filter by invitation status

Available options:
pending,
accepted,
rejected,
expired

Response

200 - application/json

List of invitations

success
enum<boolean>
Available options:
true
data
object[]
meta
object