CodeQR Domains API
The Domains API from CodeQR — 2 operation(s) for domains.
Work with this as data
Every API here is available over the APIs.io API and to AI agents over MCP.
MCP server
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
Tools for apis
7 MCP tools reach this
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.
Call it yourself
curl for this page
This API
curl "https://apis.io/api/v1/apis/codeqr-io:codeqr-io-domains-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
OpenAPI Specification
openapi: 3.2.0
info:
title: Codeqr Io Domains API
version: 0.0.1
contact:
name: CodeQR.io Support
email: contact@codeqr.io
url: https://codeqr.io/api
license:
name: AGPL-3.0 license
description: 'Operations tagged Domains across 2 of this provider''s published API definitions: codeqr-io-openapi.documented.yml, codeqr-io-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://api.codeqr.io
description: Production API
tags:
- name: Domains
paths:
/domains:
post:
operationId: createDomain
x-speakeasy-name-override: create
summary: Create a domain
description: Create a domain for the authenticated workspace.
tags:
- Domains
security:
- token: []
requestBody:
content:
application/json:
schema:
type: object
properties:
slug:
type: string
minLength: 1
description: Name of the domain.
example: acme.com
target:
type:
- string
- 'null'
description: The target URL to redirect to when accessing the domain root.
example: https://acme.com
type:
type: string
enum:
- redirect
- rewrite
default: redirect
description: The behavior type for the domain root redirect.
expiredUrl:
type:
- string
- 'null'
description: Redirect users to a specific URL when any link under this domain has expired.
example: https://acme.com/expired
archived:
type: boolean
default: false
description: Whether to archive this domain. `false` will unarchive a previously archived domain.
example: false
placeholder:
type:
- string
- 'null'
default: https://codeqr.io/help/article/what-is-codeqr
description: Provide context to your teammates in the link creation modal by showing them an example of a link to be shortened.
example: https://codeqr.io/help/article/what-is-codeqr
required:
- slug
responses:
'201':
description: The domain was created.
content:
application/json:
schema:
$ref: '#/components/schemas/DomainSchema'
'400':
$ref: '#/components/responses/400'
'401':
$ref: '#/components/responses/401'
'403':
$ref: '#/components/responses/403'
'404':
$ref: '#/components/responses/404'
'409':
$ref: '#/components/responses/409'
'410':
$ref: '#/components/responses/410'
'422':
$ref: '#/components/responses/422'
'429':
$ref: '#/components/responses/429'
'500':
$ref: '#/components/responses/500'
x-codeSamples:
- lang: JavaScript
source: "import CodeQR from '@codeqr/ts';\n\nconst client = new CodeQR({\n apiKey: process.env['CODEQR_API_KEY'], // This is the default and can be omitted\n});\n\nconst domain = await client.domains.create({ slug: 'acme.com' });\n\nconsole.log(domain.id);"
get:
operationId: listDomains
x-speakeasy-name-override: list
x-speakeasy-pagination:
type: offsetLimit
inputs:
- name: page
in: parameters
type: page
- name: pageSize
in: parameters
type: limit
outputs:
results: $
summary: Retrieve a list of domains
description: Retrieve a list of domains associated with the authenticated workspace.
tags:
- Domains
security:
- token: []
parameters:
- in: query
name: archived
description: Whether to include archived domains in the response. Defaults to `false` if not provided.
schema:
type: boolean
default: 'false'
description: Whether to include archived domains in the response. Defaults to `false` if not provided.
- in: query
name: search
description: The search term to filter the domains by.
schema:
type: string
description: The search term to filter the domains by.
- in: query
name: page
description: The page number for pagination.
schema:
type: number
default: 1
description: The page number for pagination.
example: 1
exclusiveMinimum: 0
- in: query
name: pageSize
description: The number of items per page.
schema:
type: number
maximum: 50
default: 50
description: The number of items per page.
example: 50
exclusiveMinimum: 0
responses:
'200':
description: The domains were retrieved.
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/DomainSchema'
'400':
$ref: '#/components/responses/400'
'401':
$ref: '#/components/responses/401'
'403':
$ref: '#/components/responses/403'
'404':
$ref: '#/components/responses/404'
'409':
$ref: '#/components/responses/409'
'410':
$ref: '#/components/responses/410'
'422':
$ref: '#/components/responses/422'
'429':
$ref: '#/components/responses/429'
'500':
$ref: '#/components/responses/500'
x-codeSamples:
- lang: JavaScript
source: "import CodeQR from '@codeqr/ts';\n\nconst client = new CodeQR({\n apiKey: process.env['CODEQR_API_KEY'], // This is the default and can be omitted\n});\n\nconst domains = await client.domains.list();\n\nconsole.log(domains);"
servers:
- url: https://api.codeqr.io
description: Production API
/domains/{slug}:
patch:
operationId: updateDomain
x-speakeasy-name-override: update
x-speakeasy-max-method-params: 2
summary: Update a domain
description: Update a domain for the authenticated workspace.
tags:
- Domains
security:
- token: []
parameters:
- in: path
name: slug
description: The domain name.
schema:
type: string
description: The domain name.
example: acme.com
required: true
requestBody:
content:
application/json:
schema:
type: object
properties:
slug:
type: string
minLength: 1
description: Name of the domain.
example: acme.com
target:
type:
- string
- 'null'
description: The target URL to redirect to when accessing the domain root.
example: https://acme.com
type:
type: string
enum:
- redirect
- rewrite
default: redirect
description: The behavior type for the domain root redirect.
expiredUrl:
type:
- string
- 'null'
description: Redirect users to a specific URL when any link under this domain has expired.
example: https://acme.com/expired
archived:
type: boolean
default: false
description: Whether to archive this domain. `false` will unarchive a previously archived domain.
example: false
placeholder:
type:
- string
- 'null'
default: https://codeqr.io/help/article/what-is-codeqr
description: Provide context to your teammates in the link creation modal by showing them an example of a link to be shortened.
example: https://codeqr.io/help/article/what-is-codeqr
responses:
'200':
description: The domain was updated.
content:
application/json:
schema:
$ref: '#/components/schemas/DomainSchema'
'400':
$ref: '#/components/responses/400'
'401':
$ref: '#/components/responses/401'
'403':
$ref: '#/components/responses/403'
'404':
$ref: '#/components/responses/404'
'409':
$ref: '#/components/responses/409'
'410':
$ref: '#/components/responses/410'
'422':
$ref: '#/components/responses/422'
'429':
$ref: '#/components/responses/429'
'500':
$ref: '#/components/responses/500'
x-codeSamples:
- lang: JavaScript
source: "import CodeQR from '@codeqr/ts';\n\nconst client = new CodeQR({\n apiKey: process.env['CODEQR_API_KEY'], // This is the default and can be omitted\n});\n\nconst domain = await client.domains.update('acme.com');\n\nconsole.log(domain.id);"
delete:
operationId: deleteDomain
x-speakeasy-name-override: delete
x-speakeasy-max-method-params: 1
summary: Delete a domain
description: Delete a domain from a workspace. It cannot be undone. This will also delete all the links associated with the domain.
tags:
- Domains
security:
- token: []
parameters:
- in: path
name: slug
description: The domain name.
schema:
type: string
description: The domain name.
example: acme.com
required: true
responses:
'200':
description: The domain was deleted.
content:
application/json:
schema:
type: object
properties:
slug:
type: string
description: The domain name.
example: acme.com
required:
- slug
'400':
$ref: '#/components/responses/400'
'401':
$ref: '#/components/responses/401'
'403':
$ref: '#/components/responses/403'
'404':
$ref: '#/components/responses/404'
'409':
$ref: '#/components/responses/409'
'410':
$ref: '#/components/responses/410'
'422':
$ref: '#/components/responses/422'
'429':
$ref: '#/components/responses/429'
'500':
$ref: '#/components/responses/500'
x-codeSamples:
- lang: JavaScript
source: "import CodeQR from '@codeqr/ts';\n\nconst client = new CodeQR({\n apiKey: process.env['CODEQR_API_KEY'], // This is the default and can be omitted\n});\n\nconst domain = await client.domains.delete('acme.com');\n\nconsole.log(domain.slug);"
servers:
- url: https://api.codeqr.io
description: Production API
components:
responses:
'400':
description: The server cannot or will not process the request due to something that is perceived to be a client error (e.g., malformed request syntax, invalid request message framing, or deceptive request routing).
content:
application/json:
schema:
x-speakeasy-name-override: BadRequest
type: object
properties:
error:
type: object
properties:
code:
type: string
enum:
- bad_request
description: A short code indicating the error code returned.
example: bad_request
message:
x-speakeasy-error-message: true
type: string
description: A human readable explanation of what went wrong.
example: The requested resource was not found.
doc_url:
type: string
description: A link to our documentation with more details about this error code
example: https://docs.codeqr.io/api-reference/errors#bad-request
required:
- code
- message
required:
- error
'500':
description: The server has encountered a situation it does not know how to handle.
content:
application/json:
schema:
x-speakeasy-name-override: InternalServerError
type: object
properties:
error:
type: object
properties:
code:
type: string
enum:
- internal_server_error
description: A short code indicating the error code returned.
example: internal_server_error
message:
x-speakeasy-error-message: true
type: string
description: A human readable explanation of what went wrong.
example: The requested resource was not found.
doc_url:
type: string
description: A link to our documentation with more details about this error code
example: https://docs.codeqr.io/api-reference/errors#internal-server_error
required:
- code
- message
required:
- error
'403':
description: The client does not have access rights to the content; that is, it is unauthorized, so the server is refusing to give the requested resource. Unlike 401 Unauthorized, the client's identity is known to the server.
content:
application/json:
schema:
x-speakeasy-name-override: Forbidden
type: object
properties:
error:
type: object
properties:
code:
type: string
enum:
- forbidden
description: A short code indicating the error code returned.
example: forbidden
message:
x-speakeasy-error-message: true
type: string
description: A human readable explanation of what went wrong.
example: The requested resource was not found.
doc_url:
type: string
description: A link to our documentation with more details about this error code
example: https://docs.codeqr.io/api-reference/errors#forbidden
required:
- code
- message
required:
- error
'409':
description: This response is sent when a request conflicts with the current state of the server.
content:
application/json:
schema:
x-speakeasy-name-override: Conflict
type: object
properties:
error:
type: object
properties:
code:
type: string
enum:
- conflict
description: A short code indicating the error code returned.
example: conflict
message:
x-speakeasy-error-message: true
type: string
description: A human readable explanation of what went wrong.
example: The requested resource was not found.
doc_url:
type: string
description: A link to our documentation with more details about this error code
example: https://docs.codeqr.io/api-reference/errors#conflict
required:
- code
- message
required:
- error
'429':
description: The user has sent too many requests in a given amount of time ("rate limiting")
content:
application/json:
schema:
x-speakeasy-name-override: RateLimitExceeded
type: object
properties:
error:
type: object
properties:
code:
type: string
enum:
- rate_limit_exceeded
description: A short code indicating the error code returned.
example: rate_limit_exceeded
message:
x-speakeasy-error-message: true
type: string
description: A human readable explanation of what went wrong.
example: The requested resource was not found.
doc_url:
type: string
description: A link to our documentation with more details about this error code
example: https://docs.codeqr.io/api-reference/errors#rate-limit_exceeded
required:
- code
- message
required:
- error
'401':
description: Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response.
content:
application/json:
schema:
x-speakeasy-name-override: Unauthorized
type: object
properties:
error:
type: object
properties:
code:
type: string
enum:
- unauthorized
description: A short code indicating the error code returned.
example: unauthorized
message:
x-speakeasy-error-message: true
type: string
description: A human readable explanation of what went wrong.
example: The requested resource was not found.
doc_url:
type: string
description: A link to our documentation with more details about this error code
example: https://docs.codeqr.io/api-reference/errors#unauthorized
required:
- code
- message
required:
- error
'404':
description: The server cannot find the requested resource.
content:
application/json:
schema:
x-speakeasy-name-override: NotFound
type: object
properties:
error:
type: object
properties:
code:
type: string
enum:
- not_found
description: A short code indicating the error code returned.
example: not_found
message:
x-speakeasy-error-message: true
type: string
description: A human readable explanation of what went wrong.
example: The requested resource was not found.
doc_url:
type: string
description: A link to our documentation with more details about this error code
example: https://docs.codeqr.io/api-reference/errors#not-found
required:
- code
- message
required:
- error
'422':
description: The request was well-formed but was unable to be followed due to semantic errors.
content:
application/json:
schema:
x-speakeasy-name-override: UnprocessableEntity
type: object
properties:
error:
type: object
properties:
code:
type: string
enum:
- unprocessable_entity
description: A short code indicating the error code returned.
example: unprocessable_entity
message:
x-speakeasy-error-message: true
type: string
description: A human readable explanation of what went wrong.
example: The requested resource was not found.
doc_url:
type: string
description: A link to our documentation with more details about this error code
example: https://docs.codeqr.io/api-reference/errors#unprocessable-entity
required:
- code
- message
required:
- error
'410':
description: This response is sent when the requested content has been permanently deleted from server, with no forwarding address.
content:
application/json:
schema:
x-speakeasy-name-override: InviteExpired
type: object
properties:
error:
type: object
properties:
code:
type: string
enum:
- invite_expired
description: A short code indicating the error code returned.
example: invite_expired
message:
x-speakeasy-error-message: true
type: string
description: A human readable explanation of what went wrong.
example: The requested resource was not found.
doc_url:
type: string
description: A link to our documentation with more details about this error code
example: https://docs.codeqr.io/api-reference/errors#invite-expired
required:
- code
- message
required:
- error
schemas:
DomainSchema:
type: object
properties:
id:
type: string
description: The unique identifier of the domain.
slug:
type: string
description: The domain name.
example: acme.com
verified:
type: boolean
default: false
description: Whether the domain is verified.
primary:
type: boolean
default: false
description: Whether the domain is the primary domain for the project.
archived:
type: boolean
description: Whether the domain is archived.
default: false
target:
type:
- string
- 'null'
description: The target URL to redirect to when accessing the domain root.
example: https://acme.com
type:
type: string
enum:
- redirect
- rewrite
default: redirect
description: The behavior type for the domain root redirect.
placeholder:
type: string
description: Provide context to your teammates in the link creation modal by showing them an example of a link to be shortened.
default: https://codeqr.io/help/article/what-is-codeqr
example: https://codeqr.io/help/article/what-is-codeqr
expiredUrl:
type:
- string
- 'null'
description: The URL to redirect to when a link under this domain has expired.
example: https://acme.com/expired
createdAt:
type: string
description: The date the domain was created.
updatedAt:
type: string
description: The date the domain was last updated.
required:
- id
- slug
- verified
- primary
- archived
- target
- type
- placeholder
- expiredUrl
- createdAt
- updatedAt
securitySchemes:
token:
type: http
description: Default authentication mechanism
scheme: bearer
x-refined-from:
- codeqr-io-openapi.documented.yml
- codeqr-io-openapi.yml