RErebrandly
Workspace Invites

List Workspace Invites

List all pending invites for the workspace.

get/workspaces/{workspace_id}/invites

Request

  • Base URL
    https://api.rebrandly.com/v1
  • URL
    https://api.rebrandly.com/v1/workspaces/{workspace_id}/invites
  • Auth
    API key in header apikey

Path parameters

workspace_idstring required

Query parameters

limitinteger

Maximum number of results (default 25, max 25)

orderBystring

Field to sort by

orderDir'asc' | 'desc'

Sort direction

laststring

Cursor for pagination (last item ID from previous page)

status'pending' | 'accepted' | 'expired'

Headers

apikeystring required

API key for authentication

Response

List of invites

idstring required

Invite public ID

emailstring email required

Invitee's email address

role'owner' | 'admin' | 'user' | 'guest' | 'viewer'

Role to be granted upon acceptance

status'pending' | 'accepted' | 'expired' required

Invite status

createdAtstring date-time
expiresAtstring date-time

When the invite expires

Changes

No recorded changes to this operation across all 1 revision of this API.