List all ConnectTokens

curl --request GET \
  --url https://backendapi.corbado.io/v2/connectTokens \
  --header 'Authorization: Basic <encoded-value>'

{
  "connectTokens": [
    {
      "id": "ctk-940364795071150919",
      "tokenType": "passkey-append",
      "data": {
        "displayName": "Jane Doe",
        "identifier": "[email protected]"
      },
      "connectTokenStatus": "initial",
      "expires": 1752749184,
      "secret": "ctk1_sxmexzS7RFBaJSA4V4kBFPs45bkxMK"
    }
  ],
  "paging": {
    "page": 1,
    "totalPages": 123,
    "totalItems": 123
  }
}

GET

connectTokens

curl --request GET \
  --url https://backendapi.corbado.io/v2/connectTokens \
  --header 'Authorization: Basic <encoded-value>'

{
  "connectTokens": [
    {
      "id": "ctk-940364795071150919",
      "tokenType": "passkey-append",
      "data": {
        "displayName": "Jane Doe",
        "identifier": "[email protected]"
      },
      "connectTokenStatus": "initial",
      "expires": 1752749184,
      "secret": "ctk1_sxmexzS7RFBaJSA4V4kBFPs45bkxMK"
    }
  ],
  "paging": {
    "page": 1,
    "totalPages": 123,
    "totalItems": 123
  }
}

Authorizations

Authorization

string

header

required

Basic authentication is used to authenticate requests to the Backend API. The username is the project ID and the password is the API secret.

The project ID and API secret can be found in the Developer Panel.

Query Parameters

sort

string

Field and direction to sort results. Use the format fieldName:asc or fieldName:desc.

Example:

"createdAt:desc"

filter[]

string[]

Filter results by specific fields and conditions. Format: <field>:<operator>:<value>. Supported operators include:

eq: equals (e.g. email:eq:mail@example\.com matches items where email equals [email protected])
gt: greater than (e.g. created:gt:2021-01-01T00:00:00 matches items created after Jan 1, 2021)
lt: less than (e.g. created:lt:2021-01-01T00:00:00 matches items created before Jan 1, 2021)

page

integer

default:1

The page number to retrieve for paginated results.

Example:

1

pageSize

integer

default:10

The number of items to return per page. Useful for pagination.

Example:

20

Response

List of all matching append tokens.

connectTokens

object[]

required

Show child attributes

connectTokens.id

string

required

Unique identifier of the connectToken.

Example:

"ctk-940364795071150919"

connectTokens.tokenType

enum<string>

required

Available options:

passkey-append,

passkey-delete,

passkey-list,

passkey-login

connectTokens.data

object

required

Data for passkey-append.

Option 1
Option 2
Option 3
Option 4

Show child attributes

connectTokens.data.displayName

string

required

Display name of the user.

Example:

"Jane Doe"

connectTokens.data.identifier

string

required

Example:

"[email protected]"

connectTokens.connectTokenStatus

enum<string>

required

Available options:

initial,

consumed

connectTokens.expires

integer

required

Unix time of when the connectToken expires (in seconds elapsed since January 1, 1970, 00:00:00 UTC).

Example:

1752749184

connectTokens.secret

string

Secret of the connectToken.

Example:

"ctk1_sxmexzS7RFBaJSA4V4kBFPs45bkxMK"

paging

object

required

Show child attributes

paging.page

integer

default:1

required

current page returned in response

paging.totalPages

integer

required

total number of pages available

paging.totalItems

integer

required

total number of items available

Update a passkey challenge for a user Create a connectToken

⌘I

API Reference

Frontend API

Backend API

List all ConnectTokens

Authorizations

Query Parameters

Response