Skip to main content
GET
List Invitations

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

limit
string

The maximum number of invititations to return (default 20, maximum 100).

Pattern: ^[0-9][0-9]?$|^100$
startingAfter
string

The ID of the last invitation in the previous page of results. Results will start after this invite code

status
enum<string>

Filter results by status ('APPROVED' or 'PENDING_APPROVAL').

Available options:
APPROVED,
PENDING_APPROVAL
referenceId
string

Filter results by reference ID.

driver
string

Filter results by Driver ID.

type
enum<string>

Filter results by invitation type ('PRIVATE_CHARGING' or 'PRICE_ADJUSTMENT').

Available options:
PRIVATE_CHARGING,
PRICE_ADJUSTMENT

Response

A list of invite codes

data
object
required