v1

latestOpenAPI 3.0.12026-07-243686491.1 MB
Charge Auth Tokens

Search charge auth tokens with cursor-based pagination.

Required scope: charge-auth-tokens:read </br>Organization authorization: supported

Use this endpoint for high-volume fleets where offset pagination is prohibitive. Filters are intersected with the caller's operator and team scope; ids outside the consumer's scope are rejected with 403.

get/api/v1/charge-auth-tokens/search

Query parameters

operatorIdsstring

Restrict results to these operator ids (comma-separated). Caller must have access to every id supplied.

teamIdsstring

Restrict results to these team ids (comma-separated). Caller must have access to every id supplied.

userIdsstring

Restrict results to charge auth tokens owned by these users (comma-separated).

searchstring

Free-text search on identifier and name.

blockedboolean

Filter by blocked status.

includeSubOperatorsboolean

Include sub-operators when filtering by operator. Defaults to true when operatorIds is omitted, false otherwise.

sizeinteger

Maximum number of items per page (1-100, default 10).

sortstring

Sort expression, e.g. name,ASC or created_at,DESC. Default name,ASC.

afterstring

Cursor for the next page. Use meta.after from the previous response.

beforestring

Cursor for the previous page. Ignored when after is also provided.

Response

Cursor-paginated list of charge auth tokens matching the criteria

Example response

{
  "data": [
    {
      "id": 1,
      "identifier": "38C58DB85F4",
      "type": "vehicleId",
      "teamId": 13,
      "userId": 1,
      "vehicleId": 1,
      "partnerExternalId": "ACME-12345",
      "name": "Monta Team Key",
      "operator": {
        "id": 14,
        "name": "Monta",
        "identifier": "monta",
        "partnerId": 1,
        "vatNumber": "FOO-123-ABC"
      },
      "montaNetwork": true,
      "roamingNetwork": true,
      "operatorNetwork": true,
      "activeUntil": "2023-01-11T00:00:00Z",
      "blockedAt": "2023-01-11T00:00:00Z",
      "createdAt": "2022-05-12T15:56:45.99Z",
      "updatedAt": "2022-05-12T16:56:45.99Z"
    }
  ],
  "meta": {
    "itemCount": 10,
    "perPage": 50,
    "after": "1290",
    "before": "1200"
  }
}