GET
/
domains
Retrieve a list of domains
curl --request GET \
  --url https://api.codeqr.io/domains \
  --header 'Authorization: Bearer <token>'
[
  {
    "id": "<string>",
    "slug": "acme.com",
    "verified": false,
    "primary": false,
    "archived": false,
    "placeholder": "https://codeqr.io/help/article/what-is-codeqr",
    "expiredUrl": "https://acme.com/expired",
    "createdAt": "<string>",
    "updatedAt": "<string>"
  }
]

Authorizations

​
Authorization
string
header
required

Default authentication mechanism

Query Parameters

​
archived
boolean
default:false

Whether to include archived domains in the response. Defaults to false if not provided.

​
search
string

The search term to filter the domains by.

​
page
number
default:1

The page number for pagination.

Required range: x > 0
Example:

1

​
pageSize
number
default:50

The number of items per page.

Required range: 0 < x <= 50
Example:

50

Response

200
application/json

The domains were retrieved.

The response is of type object[].