• Identity API

Invite Code

get

List Invite Codes

Retrieve a list of invite codes based on specified criteria

limitstring

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

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

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

Responses

Response examples

A list of invite codes

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

Generate Invite codes

Generate invite codes for private charging or price adjustment purposes.

typestring
Enum
  • PRIVATE_CHARGING
  • PRICING_ADJUSTMENT
referenceIdstring
numberOfCodesnumber

Responses

Request examples

{
  "type": "PRIVATE_CHARGING",
  "referenceId": "string",
  "numberOfCodes": 123.0
}

Response examples

OK

{
  "data": "string"
}

Was this page helpful?