/tokens (GET)

GET

/tokens

const url = 'https://example.com/api/v1/tokens';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://example.com/api/v1/tokens \
  --header 'Authorization: Bearer <token>'

Authorizations

bearer

Responses

200

Default Response

application/json

Array<object>

object

required

string format: uuid

/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/

name

required

string

role

required

string

Allowed values: owner admin domain_admin mailbox_user

permissions

required

Any of:

Array<string>
null

Array<string>

Allowed values: messages:send messages:read

senders

required

Any of:

Array<string>
null

Array<string>

lastUsedAt

required

Any of:

string
null

string format: date-time

/^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$/

expiresAt

required

Any of:

string
null

string format: date-time

createdAt

required

string format: date-time

Example

[
  {
    "role": "owner",
    "permissions": [
      "messages:send"
    ]
  }
]