• Identity API

Invitation

get

List Invitations

Retrieve a list of invitations based on specified criteria

limitstring

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

Pattern
^[0-9][0-9]?$|^100$
startingAfterstring

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

statusstring

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

Enum
  • APPROVED
  • PENDING_APPROVAL
referenceIdstring

Filter results by reference ID.

driverstring

Filter results by Driver ID.

typestring

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

Enum
  • PRIVATE_CHARGING
  • PRICE_ADJUSTMENT

Responses

Response examples

A list of invite codes

{
  "data": {
    "hasMore": true,
    "items": [
      {
        "id": "string",
        "type": "PRIVATE_CHARGING",
        "referenceId": "string",
        "driverId": "string",
        "status": "PENDING_APPROVAL",
        "network": {
          "id": "string"
        },
        "createdAt": "2023-06-07T17:32:28Z",
        "updatedAt": "2023-06-07T17:32:28Z"
      }
    ]
  }
}
post

Create an invitation with an invite code

Create an invitation with an invite code

driverIdstring

required

codestring

required

Responses

Request examples

{
  "driverId": "string",
  "code": "string"
}

Response examples

OK

{
  "data": {
    "id": "string",
    "type": "PRIVATE_CHARGING",
    "referenceId": "string",
    "driverId": "string",
    "status": "PENDING_APPROVAL",
    "network": {
      "id": "string"
    },
    "createdAt": "2023-06-07T17:32:28Z",
    "updatedAt": "2023-06-07T17:32:28Z"
  }
}
patch

Resolve Invitation

Resolve an invitation based on the specified invitationId and status (APPROVED or DENIED).

statusstring

required

Enum
  • APPROVED
  • DENIED

Responses

Request examples

{
  "status": "APPROVED"
}

Response examples

OK

{
  "data": {
    "id": "string",
    "type": "PRIVATE_CHARGING",
    "referenceId": "string",
    "driverId": "string",
    "status": "PENDING_APPROVAL",
    "network": {
      "id": "string"
    },
    "createdAt": "2023-06-07T17:32:28Z",
    "updatedAt": "2023-06-07T17:32:28Z"
  }
}

Was this page helpful?