Skip to main content
GET
list Tokens

Authorizations

Authorization
string
header
required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Response

JSON A list array with a data property that contains an array of up to limit Token, starting after the specified starting_after RatePlan (or ending before the specified ending_before RatePlan). Each entry in the array is a full RatePlan object. If no more objects are available, the resulting array will be empty. This request should never throw an error. A list of Token objects matching the query. Also:

  • “total_count”: Integer count of the number of Token in the returned list.

  • “url”: The query string provided in the request

  • “next”: The route (partial URL) to the next Token object (string to select the “next”); included vid should match that of the last object returned here

  • “previous”: The route (partial URL) to the previous Token object (string to select the “previous”); included vid should match that of the first object returned here

object
enum<string>
Available options:
List
total_count
integer

Integer count of the number of items in the returned list.

data
object[]
url
string

The query string provided in the request

next
string

The route (partial URL) to the next Token object (string to select the “next”); included id should match that of the last object returned here.

previous
string

The route (partial URL) to the previous Token object (string to select the “previous”); included id should match that of the first object returned here.

Example:

"{ \"object\": \"List\", \"data\": [ { \"object\": \"Token\", \"id\": \"Test_Token123\", \"vid\": \"430441b0f936e412c40ed96cbaff2bcaf24f4e32\", \"description\": \"Token created\" } ], \"total_count\": 1, \"url\": \"/tokens\", \"next\": \"/tokens?starting_after=Test_Token123\", \"previous\": \"/tokens?ending_before=Test_Token123\" }"