Skip to content
clearance.rest

List authorization links

GET
/emails/auth-links
curl --request GET \
  --url 'https://api.clearance.rest/emails/auth-links?limit=50' \
  --header 'X-API-Key: <X-API-Key>'

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Query Parameters

Section titled “Query Parameters”
status
Array<string>
Allowed values: active expired revoked exhausted

Comma-separated link statuses; a link matches when it has any of them (default: all).

limit
integer
default: 50 >= 1 <= 200

Page size (1-200).

cursor
string

The next_cursor value of the previous page.

Responses

Section titled “Responses”

200

Section titled “200”

Default Response

Media typeapplication/json
object
success
required
boolean
links
required
Array<object>

A public link that lets anyone connect a mailbox to the project.

object
id
required
string
url
required

The page to share, e.g. https://links.clearance.rest/.

string
status
required
string
Allowed values: active expired revoked exhausted
expires_at
required

UTC timestamp (ISO 8601).

string
max_uses
required
integer
>= -9007199254740991 <= 9007199254740991
use_count
required
integer
>= -9007199254740991 <= 9007199254740991
providers
required
Array<string>
Allowed values: gmail outlook
locale
required
string
Allowed values: en tr
return_url
required
string | null
branding
required

Branding of the link page (project defaults overridden by the link); null fields use the default look.

object
name
required
string | null
logo_url
required
string | null
description
required
string | null
primary_color
required
string | null
metadata
required

Free-form JSON object (at most 16 KB, 5 levels deep, keys up to 64 characters).

object
key
additional properties
project_id
required
string
created_by
required
string | null
created_at
required

UTC timestamp (ISO 8601).

string
last_used_at
required
Any of:

UTC timestamp (ISO 8601).

string
revoked_at
required
Any of:

UTC timestamp (ISO 8601).

string
next_cursor
required
Any of:

Opaque cursor of the next page.

string
Example
{
  "success": true,
  "links": [
    {
      "status": "active",
      "providers": [
        "gmail"
      ],
      "locale": "en"
    }
  ]
}

400

Section titled “400”

Default Response

Media typeapplication/json

Error envelope returned by every JSON endpoint.

object
success
required
boolean
error
required
object
code
required

Machine-readable error code (snake_case).

string
message
required

Human-readable message.

string
details

Extra context for the error.

object
key
additional properties
Example
{
  "success": false
}

401

Section titled “401”

Default Response

Media typeapplication/json

Error envelope returned by every JSON endpoint.

object
success
required
boolean
error
required
object
code
required

Machine-readable error code (snake_case).

string
message
required

Human-readable message.

string
details

Extra context for the error.

object
key
additional properties
Example
{
  "success": false
}

403

Section titled “403”

Default Response

Media typeapplication/json

Error envelope returned by every JSON endpoint.

object
success
required
boolean
error
required
object
code
required

Machine-readable error code (snake_case).

string
message
required

Human-readable message.

string
details

Extra context for the error.

object
key
additional properties
Example
{
  "success": false
}