v4

latestOpenAPI 3.1.02026-08-02261331761.5 KB

Invites

List Organization Invites

Lists pending organization invites

get/v2/orgs/{org_id}/invites

Path parameters

org_idstring required

Either the unique id of the organization, or the URL-friendly key of the organization (i.e: the "slug").

Query parameters

pageinteger

Page number of the results to fetch, starting at 1.

per_pageinteger

The number of results per page (max 100).

Response

Successful Response

member_idstring uuid

Unique id of the invite

emailstring email required

The invited member's email address

role'admin' | 'write' | 'read' | 'no_access'

An enumeration.

idstring uuid required

Unique id of the invite

organization_idstring uuid required

Unique id of the organization that the invite belongs to.

invite_codestring uuid required

The invite code that is sent to the member's email

created_atstring date-time required

Date and time when the invite was created (ISO_8601 format).

status'pending' | 'accepted' | 'failed' | 'canceled' required

An enumeration.

failed_reasonstring

if failed, the reason the invitation failed

Example response

[
  {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "organization_id": "7c60d51f-b44e-4682-87d6-449835ea4de6",
    "invite_code": "40ef0e48-a11f-4963-a229-e396c9eeefff",
    "email": "jane@coolcompany.com",
    "role": "admin",
    "created_at": "2019-08-24T14:15:22Z",
    "status": "pending",
    "failed_reason": ""
  }
]