Skip to content
VaartixVaartix Docs

List API keys

GET
/api-keys
curl --request GET \
  --url https://api.vaartix.com/api-keys \
  --header 'Authorization: Bearer <token>'

Active keys. The key itself is never returned again after creation.

Authorizations

Section titled “Authorizations”

Responses

Section titled “Responses”

200

Section titled “200”

Your team’s API keys.

Media typeapplication/json
object
data
required
Array<object>
object
id
string
name
string
prefix

The first characters of the key, to recognise it., example: vx_live_pt7m

string
scope
string
Allowed values: send full
domainId
string | null
lastUsedAt
string | null format: date-time
revokedAt
string | null format: date-time
createdAt
string format: date-time

Example 

{
  "data": [
    {
      "scope": "send"
    }
  ]
}

401

Section titled “401”

unauthorized: the API key is missing, invalid or revoked.

Media typeapplication/json
object
error
required
object
type
required

Stable, machine-readable error type.

string
Allowed values: validation_error unauthorized forbidden not_found conflict rate_limited daily_quota_exceeded domain_not_verified invalid_from_address account_paused idempotency_conflict bad_request internal_error
message
required

Human-readable explanation, safe to show to developers.

string

Example 

{
  "error": {
    "type": "validation_error"
  }
}

403

Section titled “403”

forbidden: the key cannot do this, for example a send-only key on a management endpoint.

Media typeapplication/json
object
error
required
object
type
required

Stable, machine-readable error type.

string
Allowed values: validation_error unauthorized forbidden not_found conflict rate_limited daily_quota_exceeded domain_not_verified invalid_from_address account_paused idempotency_conflict bad_request internal_error
message
required

Human-readable explanation, safe to show to developers.

string

Example 

{
  "error": {
    "type": "validation_error"
  }
}