Get one-time tokens

GET /api/one-time-tokens

Get a list of one-time tokens, filtering by email and status, with optional pagination.

Query parameters

  • email string(regex)

    Filter one-time tokens by email address.

    Format should match the following pattern: /^\S+@\S+\.\S+$/.

  • status string

    Filter one-time tokens by status.

    Values are active, consumed, revoked, or expired.

  • page integer

    Page number (starts from 1).

    Minimum value is 1. Default value is 1.

  • page_size integer

    Entries per page.

    Minimum value is 1. Default value is 20.

Responses

  • 200 application/json

    A list of one-time tokens.

    Hide response attributes Show response attributes object
    • tenantId string Required

      Maximum length is 21.

    • id string Required

      Minimum length is 1, maximum length is 21.

    • email string Required

      Minimum length is 1, maximum length is 128.

    • token string Required

      Minimum length is 1, maximum length is 256.

    • context object Required
      Hide context attribute Show context attribute object
    • status string Required

      Values are active, consumed, revoked, or expired.

    • createdAt number Required
    • expiresAt number Required
  • Bad Request

  • Unauthorized

  • Forbidden

GET /api/one-time-tokens
curl \
 --request GET 'https://[tenant_id].logto.app/api/one-time-tokens' \
 --header "Authorization: Bearer $ACCESS_TOKEN"
Response examples (200)
[
  {
    "tenantId": "string",
    "id": "string",
    "email": "string",
    "token": "string",
    "context": {
      "jitOrganizationIds": [
        "string"
      ]
    },
    "status": "active",
    "createdAt": 42.0,
    "expiresAt": 42.0
  }
]