List domains

GET

/v1/domains

curl --request GET \
  --url https://platform.fomr.io/v1/domains \
  --header 'Authorization: Bearer <token>'

Lists the custom domains and fomr subdomains of the organization with their verification state. Use the host of a verified, active domain to set the share link of a form. Domains are added and verified in the app. Needs domains:read. Costs 1 API credit.

Authorizations

• bearerAuth

Responses

200

Default Response

Media typeapplication/json

object

data

required

Every domain of the organization, ordered by host. Domains are added and verified in the app.

Array<object>

object

host

required

The domain host, such as forms.example.com. Pass it as domain to setFormDomain.

string

>= 4 characters <= 55 characters /^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9-]*[a-zA-Z0-9])\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9-]*[A-Za-z0-9])$/

status

required

Verification state: verified, pending while DNS is checked, or failed.

string

Allowed values: verified pending failed

is_active

required

Whether the plan of the organization keeps the domain serving forms. Inactive domains cannot be bound to a form.

boolean

is_fomr_subdomain

required

Whether the domain is a fomr subdomain rather than a domain the organization owns.

boolean

created_at

required

When the domain was added.

string format: date-time

/^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$/

Example

{
  "data": [
    {
      "status": "verified"
    }
  ]
}

401

Default Response

Media typeapplication/json

object

code

required

The stable code to branch on.

string

Allowed values: INVALID_INPUT UNAUTHORIZED PERSONAL_ACCESS_TOKEN_EXPIRED PERSONAL_ACCESS_TOKEN_REVOKED PLAN_LIMIT_REACHED PRO_FEATURE_REQUIRED FORBIDDEN FORM_PUBLISH_EMAIL_UNVERIFIED ORGANIZATION_MEMBER_BLOCKED PERSONAL_ACCESS_TOKEN_NOT_PERMITTED NOT_FOUND FORM_NOT_PUBLISHED NO_DRAFT_DURING_PUBLISH FORM_ARCHIVED FORM_CONVERSION_BLOCKED FORM_PUBLISH_REVISION_CONFLICT PAYLOAD_TOO_LARGE FORM_PUBLISH_VALIDATION_FAILED FORM_SAFETY_REJECTED TOO_MANY_REQUESTS API_COOLDOWN SERVER AI_SERVICE_UNAVAILABLE SERVICE_UNAVAILABLE

message

required

A human-readable explanation. Not part of the contract; never branch on it.

string

request_id

required

The ID of the failed request, also sent as the X-Request-Id response header.

string

Example

{
  "code": "INVALID_INPUT"
}

403

Default Response

Media typeapplication/json

object

code

required

The stable code to branch on.

string

Allowed values: INVALID_INPUT UNAUTHORIZED PERSONAL_ACCESS_TOKEN_EXPIRED PERSONAL_ACCESS_TOKEN_REVOKED PLAN_LIMIT_REACHED PRO_FEATURE_REQUIRED FORBIDDEN FORM_PUBLISH_EMAIL_UNVERIFIED ORGANIZATION_MEMBER_BLOCKED PERSONAL_ACCESS_TOKEN_NOT_PERMITTED NOT_FOUND FORM_NOT_PUBLISHED NO_DRAFT_DURING_PUBLISH FORM_ARCHIVED FORM_CONVERSION_BLOCKED FORM_PUBLISH_REVISION_CONFLICT PAYLOAD_TOO_LARGE FORM_PUBLISH_VALIDATION_FAILED FORM_SAFETY_REJECTED TOO_MANY_REQUESTS API_COOLDOWN SERVER AI_SERVICE_UNAVAILABLE SERVICE_UNAVAILABLE

message

required

A human-readable explanation. Not part of the contract; never branch on it.

string

request_id

required

The ID of the failed request, also sent as the X-Request-Id response header.

string

required_permission

required

Any of:

string

string

null

null

Example

{
  "code": "INVALID_INPUT"
}

429

A rejected call. The organization budget names the policy it rejected the call under; the request floor that bounds hammering sends the envelope alone.

Media typeapplication/json

Any of:

object

object

code

required

The stable code to branch on.

string

Allowed values: INVALID_INPUT UNAUTHORIZED PERSONAL_ACCESS_TOKEN_EXPIRED PERSONAL_ACCESS_TOKEN_REVOKED PLAN_LIMIT_REACHED PRO_FEATURE_REQUIRED FORBIDDEN FORM_PUBLISH_EMAIL_UNVERIFIED ORGANIZATION_MEMBER_BLOCKED PERSONAL_ACCESS_TOKEN_NOT_PERMITTED NOT_FOUND FORM_NOT_PUBLISHED NO_DRAFT_DURING_PUBLISH FORM_ARCHIVED FORM_CONVERSION_BLOCKED FORM_PUBLISH_REVISION_CONFLICT PAYLOAD_TOO_LARGE FORM_PUBLISH_VALIDATION_FAILED FORM_SAFETY_REJECTED TOO_MANY_REQUESTS API_COOLDOWN SERVER AI_SERVICE_UNAVAILABLE SERVICE_UNAVAILABLE

message

required

A human-readable explanation. Not part of the contract; never branch on it.

string

request_id

required

The ID of the failed request, also sent as the X-Request-Id response header.

string

policy

required

The policy that rejected the call.

string

Allowed values: minute burst

plan

required

The plan whose numbers were applied.

string

Allowed values: free pro

limit

required

The policy limit in credits.

integer

>= -9007199254740991 <= 9007199254740991

used

required

Credits already spent in the open window.

integer

>= -9007199254740991 <= 9007199254740991

remaining

required

Credits still available under the policy.

integer

>= -9007199254740991 <= 9007199254740991

cost

required

What the rejected call would have cost.

integer

>= -9007199254740991 <= 9007199254740991

window_seconds

required

How long the policy window lasts.

integer

>= -9007199254740991 <= 9007199254740991

cooldown_until

required

Any of:

string

string format: date-time

/^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$/

null

null

resets_at

required

When the window that rejected the call ends.

string format: date-time

/^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$/

retry_after_seconds

required

Seconds to wait before retrying. Also sent as the Retry-After response header.

integer

>= -9007199254740991 <= 9007199254740991

upgrade_url

required

Any of:

string

string

null

null

object

object

code

required

The stable code to branch on.

string

Allowed values: INVALID_INPUT UNAUTHORIZED PERSONAL_ACCESS_TOKEN_EXPIRED PERSONAL_ACCESS_TOKEN_REVOKED PLAN_LIMIT_REACHED PRO_FEATURE_REQUIRED FORBIDDEN FORM_PUBLISH_EMAIL_UNVERIFIED ORGANIZATION_MEMBER_BLOCKED PERSONAL_ACCESS_TOKEN_NOT_PERMITTED NOT_FOUND FORM_NOT_PUBLISHED NO_DRAFT_DURING_PUBLISH FORM_ARCHIVED FORM_CONVERSION_BLOCKED FORM_PUBLISH_REVISION_CONFLICT PAYLOAD_TOO_LARGE FORM_PUBLISH_VALIDATION_FAILED FORM_SAFETY_REJECTED TOO_MANY_REQUESTS API_COOLDOWN SERVER AI_SERVICE_UNAVAILABLE SERVICE_UNAVAILABLE

message

required

A human-readable explanation. Not part of the contract; never branch on it.

string

request_id

required

The ID of the failed request, also sent as the X-Request-Id response header.

string

Example

{
  "code": "INVALID_INPUT",
  "policy": "minute",
  "plan": "free"
}

500

Default Response

Media typeapplication/json

object

code

required

The stable code to branch on.

string

Allowed values: INVALID_INPUT UNAUTHORIZED PERSONAL_ACCESS_TOKEN_EXPIRED PERSONAL_ACCESS_TOKEN_REVOKED PLAN_LIMIT_REACHED PRO_FEATURE_REQUIRED FORBIDDEN FORM_PUBLISH_EMAIL_UNVERIFIED ORGANIZATION_MEMBER_BLOCKED PERSONAL_ACCESS_TOKEN_NOT_PERMITTED NOT_FOUND FORM_NOT_PUBLISHED NO_DRAFT_DURING_PUBLISH FORM_ARCHIVED FORM_CONVERSION_BLOCKED FORM_PUBLISH_REVISION_CONFLICT PAYLOAD_TOO_LARGE FORM_PUBLISH_VALIDATION_FAILED FORM_SAFETY_REJECTED TOO_MANY_REQUESTS API_COOLDOWN SERVER AI_SERVICE_UNAVAILABLE SERVICE_UNAVAILABLE

message

required

A human-readable explanation. Not part of the contract; never branch on it.

string

request_id

required

The ID of the failed request, also sent as the X-Request-Id response header.

string

Example

{
  "code": "INVALID_INPUT"
}