--- updatedAt: 2026-06-04T19:58:43.000Z agentTools: projectIndex: https://docs.wristband.dev/llms.txt --- # Query Tenant Email Domains Queries email domains, scoped to a tenant, based on a query expression. ### Query Filter Attributes | Name | Type | Case Sensitive | Supported Comparison Operators | | ------------ | ------ | -------------- | ----------------------------------- | | `domainName` | String | No | eq, ne, sw, lt, le, gt, ge, in, nin | | `status` | String | No | eq, ne, in, nin | ### Sort Attributes * `domainName` * `status` ### Required Permissions Below is the list of required permissions needed to interact with this API. For each permission, the allowed permission boundaries are also specified. | Permission | Boundary | Description | | --------------------- | --------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | **email-domain:read** | Application | The subject can perform this query if the tenant specified in the URL path is associated with the subject's application. | | | Tenant | The subject can perform this query if they are associated with the tenant specified in the URL path. | | | Tenant Inclusion List | The subject can perform this query if the tenant specified in the URL path is included in the tenant inclusion list. | | | Tenant Exclusion List | The subject can perform this query if the tenant specified in the URL path belongs to the subject's associated application and is not included in the tenant exclusion list. | # OpenAPI definition ```json { "openapi": "3.1.0", "info": { "title": "Resource Management APIs", "version": "1.0.0", "description": "Resource Management APIs", "license": { "name": "Private", "url": "https://wristband.dev/terms/" }, "termsOfService": "https://wristband.dev/terms/", "contact": { "name": "Wristband Support", "email": "support@wristband.dev", "url": "https://wristband.dev/contact/" } }, "servers": [ { "url": "https://{application_vanity_domain}", "description": "Wristband application scoped URL.", "variables": { "application_vanity_domain": { "default": "yourapp-yourorg.us.wristband.dev", "description": "Wristband vanity domain scoped to a specific application." } } } ], "tags": [ { "name": "Email Domains", "description": "Email Domains", "x-displayName": "Email Domains" } ], "paths": { "/api/v1/tenants/{tenantId}/email-domains": { "parameters": [ { "$ref": "#/components/parameters/Resource_Management_APIs_TenantId" } ], "get": { "summary": "Query Tenant Email Domains", "operationId": "queryTenantEmailDomainsV1", "tags": [ "Email Domains" ], "parameters": [ { "$ref": "#/components/parameters/Resource_Management_APIs_Query" }, { "$ref": "#/components/parameters/Resource_Management_APIs_SortBy" }, { "$ref": "#/components/parameters/Resource_Management_APIs_StartIndex" }, { "$ref": "#/components/parameters/Resource_Management_APIs_Count" }, { "$ref": "#/components/parameters/Resource_Management_APIs_Fields" }, { "$ref": "#/components/parameters/Resource_Management_APIs_IncludeApplicationEmailDomains" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Resource_Management_APIs_EmailDomainOffsetPaginatedResults" }, "examples": { "Example 1": { "$ref": "#/components/examples/Resource_Management_APIs_EmailDomainOffsetPaginatedResults" } } } } }, "400": { "$ref": "#/components/responses/Resource_Management_APIs_400-default" }, "401": { "$ref": "#/components/responses/Resource_Management_APIs_401" }, "403": { "$ref": "#/components/responses/Resource_Management_APIs_403" }, "404": { "$ref": "#/components/responses/Resource_Management_APIs_404-tenant-not-found" }, "405": { "$ref": "#/components/responses/Resource_Management_APIs_405" }, "406": { "$ref": "#/components/responses/Resource_Management_APIs_406" }, "500": { "$ref": "#/components/responses/Resource_Management_APIs_500" }, "503": { "$ref": "#/components/responses/Resource_Management_APIs_503" } }, "security": [ { "Resource_Management_APIs_BearerAuth": [] } ] } } }, "components": { "securitySchemes": { "Resource_Management_APIs_BearerAuth": { "type": "http", "scheme": "bearer", "bearerFormat": "JWT" } }, "parameters": { "Resource_Management_APIs_Fields": { "name": "fields", "in": "query", "required": false, "schema": { "type": "string", "default": "*", "example": "field1,field2", "minLength": 0 }, "description": "List of resource fields that should be returned in a response. The wildcard value of `*` can be used to return all fields for the resource.", "style": "form" }, "Resource_Management_APIs_Query": { "name": "query", "in": "query", "required": false, "schema": { "type": "string", "default": "\"\"", "example": "foo eq 'bar'", "minLength": 0 }, "description": "Query expression used to filter returned results in a query API call." }, "Resource_Management_APIs_SortBy": { "name": "sort_by", "in": "query", "required": false, "schema": { "type": "string", "example": "foo:desc,bar:asc" }, "description": "List of attributes that the results of a query should be sorted by along with their corresponding sort orders. The items that occur earlier in the list will have higher sorting precedence than those that occur later in the list." }, "Resource_Management_APIs_StartIndex": { "name": "start_index", "in": "query", "required": false, "schema": { "type": "number", "default": 1, "example": 1, "minimum": 1 }, "description": "A 1-based index indicating the position of the first item that should be returned in the query response." }, "Resource_Management_APIs_Count": { "name": "count", "in": "query", "required": false, "schema": { "type": "number", "minimum": 0, "default": 20, "example": 20 }, "description": "The maximum number of results that can be returned in a query response. If the value is set to 0 then the items array in the response will be empty; however the total results will still be set so you can see how many items this query matched." }, "Resource_Management_APIs_TenantId": { "name": "tenantId", "description": "The ID of the tenant that the resource or action is scoped to.", "in": "path", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 26, "example": "fjffnbwairfhzkakzjtemooh7e" } }, "Resource_Management_APIs_IncludeApplicationEmailDomains": { "name": "include_application_email_domains", "description": "Boolean indicating if the tenant's corresponding application email domains should be returned\nin the result set.", "in": "query", "required": false, "schema": { "type": "boolean", "default": false, "example": true } } }, "schemas": { "Resource_Management_APIs_id": { "type": "string", "minLength": 1, "maxLength": 26, "example": "pl4a4aa4jzydksmrf3jnu5yfcw", "description": "Globally unique Id of the resource.", "readOnly": true }, "Resource_Management_APIs_api-error": { "title": "ApiError", "type": "object", "description": "API error object", "x-examples": { "Example 1": { "code": "invalid_request", "message": "The request was invalid", "ticket": "11t7n71hi5e6t" } }, "properties": { "type": { "type": "string", "example": "base_error", "minLength": 1, "description": "The type of the API error.", "readOnly": true }, "code": { "type": "string", "example": "invalid_request", "minLength": 1, "description": "A code identifying the error that occurred.", "readOnly": true }, "message": { "type": "string", "example": "The request was invalid", "description": "A free text message describing the error. This error message is only meant to help developers understand the cause of the error. It should not be used for programmatic purposes.", "readOnly": true }, "ticket": { "type": "string", "example": "11t7n71hi5e6t", "description": "Ticket that can help correlate the error to the backend", "readOnly": true }, "details": { "type": "object", "description": "A map of details about the error. The keys are defined by the API.", "additionalProperties": {}, "example": { "attemptsRemaining": 4 } } }, "required": [ "type", "code" ] }, "Resource_Management_APIs_constraint-violations-api-error": { "title": "ConstraintViolationsApiError", "description": "An API error that occurred due to a constraint violation", "allOf": [ { "$ref": "#/components/schemas/Resource_Management_APIs_api-error" }, { "type": "object", "readOnly": true, "required": [ "violations" ], "properties": { "violations": { "type": "object", "readOnly": true, "required": [ "code" ], "properties": { "code": { "type": "string", "description": "A code identifying the constraint violation.", "minLength": 1, "example": "too_long" }, "constraintAttributes": { "type": "object", "description": "A map of constraint attribute values.", "additionalProperties": { "type": "string" }, "example": { "maxLength": "10" } } } } } } ], "x-examples": { "Example 1": { "type": "constraint_violations_error", "code": "message_body_constraint_violations", "message": "The request contained invalid fields", "ticket": "11t7n71hi5e6t", "violations": { "field1": { "code": "too_long", "constraintAttributes": { "maxLength": "10" } }, "field2": { "code": "not_null" } } } } }, "Resource_Management_APIs_offset-paginated-results": { "title": "OffsetPaginatedResults", "type": "object", "description": "Offset paginated results returned from a query API call.", "x-examples": { "Example 1": { "totalResults": 200, "startIndex": 1, "itemsPerPage": 10 } }, "properties": { "totalResults": { "type": "integer", "format": "int64", "example": 200, "minimum": 0, "description": "The total number of results that satisfied the query expression.", "readOnly": true }, "startIndex": { "type": "integer", "format": "int32", "example": 1, "minimum": 1, "description": "A 1-based index representing the position of the first result in the returned query response.", "readOnly": true }, "itemsPerPage": { "type": "integer", "format": "int32", "example": 10, "minimum": 0, "description": "The number of results returned in a page.", "readOnly": true } }, "required": [ "totalResults", "startIndex", "itemsPerPage" ] }, "Resource_Management_APIs_createOwnerId": { "description": "[Required on Create] The ID of the owner of the resource.", "type": "string", "minLength": 1, "maxLength": 26, "example": "d7aml4q5lza3fdi2gavzdliouy" }, "Resource_Management_APIs_DnsRecord": { "title": "DNS Record", "description": "DNS Record", "type": "object", "readOnly": true, "x-tags": [ "Models" ], "properties": { "name": { "description": "The name of the DNS record.", "type": "string", "minLength": 1, "maxLength": 253, "readOnly": true, "example": "_wb-verification.mail.custom.io" }, "recordType": { "description": "The type of the DNS record.", "type": "string", "enum": [ "CNAME", "TXT" ], "minLength": 1, "maxLength": 45, "readOnly": true, "example": "TXT" }, "value": { "description": "The DNS record value.", "type": "string", "minLength": 1, "maxLength": 512, "readOnly": true, "example": "v=spf1 include:_spf.wristband.dev ~all" }, "status": { "description": "The status of the DNS record. If the record can be resolved using a DNS lookup and has the correct value then its status will be set to `VERIFIED`.", "type": "string", "enum": [ "UNVERIFIED", "VERIFIED" ], "minLength": 1, "maxLength": 45, "readOnly": true, "example": "VERIFIED" }, "isActive": { "description": "Boolean indicating if the DNS record is actively being used. In order for an email domain to have a status of `VERIFIED`, all its associated active DNS records must have a status of `VERIFIED`.", "type": "boolean", "readOnly": true, "example": true } }, "example": { "name": "_wb-verification.mail.custom.io", "recordType": "TXT", "value": "v=spf1 include:_spf.wristband.dev ~all", "status": "VERIFIED", "isActive": true } }, "Resource_Management_APIs_createOwnerType": { "description": "[Required on Create] The type of the owner of the resource.", "type": "string", "enum": [ "APPLICATION", "TENANT" ], "minLength": 1, "maxLength": 30, "example": "APPLICATION" }, "Resource_Management_APIs_EmailDomain": { "title": "Email Domain", "description": "Email Domain", "type": "object", "x-tags": [ "Models" ], "properties": { "id": { "$ref": "#/components/schemas/Resource_Management_APIs_id" }, "ownerType": { "$ref": "#/components/schemas/Resource_Management_APIs_createOwnerType" }, "ownerId": { "$ref": "#/components/schemas/Resource_Management_APIs_createOwnerId" }, "domainName": { "description": "[Required on Create] The custom domain name that can be used when sending emails. This value must be a subdomain of a valid public suffix and can't end with `wristband.dev`. The domain name must be unique (case-insensitive) for the specified owner.", "type": "string", "pattern": "hostname", "minLength": 1, "maxLength": 100, "example": "mail.custom.com" }, "status": { "description": "The status of the email domain. In order to send emails using this domain the status must be `VERIFIED`.", "type": "string", "enum": [ "UNVERIFIED", "VERIFIED" ], "minLength": 1, "maxLength": 45, "readOnly": true, "example": "VERIFIED" }, "dnsRecords": { "description": "The DNS records associated to the email domain. All active DNS records must have a status of `VERIFIED` in order for the email domain to have a status of `VERIFIED`.", "type": "array", "readOnly": true, "uniqueItems": true, "items": { "$ref": "#/components/schemas/Resource_Management_APIs_DnsRecord" } }, "metadata": { "$ref": "#/components/schemas/Resource_Management_APIs_EmailDomainMetadata" } }, "example": { "id": "a4jzydksmrf3jnu5yfcwpl4a4a", "ownerType": "APPLICATION", "ownerId": "4a4aa4jzydksmrf3jnu5yfcwpl", "domainName": "mail.custom.com", "status": "VERIFIED", "dnsRecords": [ { "name": "_wb-verification.mail.custom.io", "recordType": "TXT", "value": "verification-code", "status": "VERIFIED", "isActive": true }, { "name": "mail.custom.io", "recordType": "TXT", "value": "v=spf1 include:_spf.wristband.dev ~all", "status": "VERIFIED", "isActive": true }, { "name": "wb-k1._domainkey.mail.custom.io", "recordType": "CNAME", "value": "k1.abcd.dkim.wristband.dev", "status": "VERIFIED", "isActive": true }, { "name": "wb-k2._domainkey.mail.custom.io", "recordType": "CNAME", "value": "k2.abcd.dkim.wristband.dev", "status": "VERIFIED", "isActive": false } ], "metadata": { "lastModifiedTime": "2016-06-13T19:49:31.686Z", "creationTime": "2016-06-13T19:49:31.686Z", "lastVerificationTime": "2016-06-13T19:49:31.686Z" } } }, "Resource_Management_APIs_EmailDomainMetadata": { "title": "Email Domain Metadata", "description": "Email Domain Metadata", "type": "object", "readOnly": true, "x-tags": [ "Models" ], "properties": { "lastModifiedTime": { "type": "string", "format": "date-time", "example": "2016-06-13T19:49:31.686Z", "description": "The time at which the email domain was last modified", "readOnly": true }, "creationTime": { "type": "string", "format": "date-time", "example": "2016-06-13T19:49:31.686Z", "description": "The time at which the email domain was created", "readOnly": true }, "lastVerificationTime": { "type": "string", "format": "date-time", "example": "2016-06-13T19:49:31.686Z", "description": "The time at which the email domain was last verified.", "readOnly": true } }, "example": { "lastModifiedTime": "2016-06-13T19:49:31.686Z", "creationTime": "2016-06-13T19:49:31.686Z", "lastVerificationTime": "2016-06-13T19:49:31.686Z" } }, "Resource_Management_APIs_EmailDomainOffsetPaginatedResults": { "title": "EmailDomainOffsetPaginatedResults", "description": "Email Domain Offset Paginated Results", "x-tags": [ "Models" ], "allOf": [ { "$ref": "#/components/schemas/Resource_Management_APIs_offset-paginated-results" }, { "type": "object", "description": "Email Domain Offset Paginated Results", "properties": { "items": { "type": "array", "description": "Array of email domains that satisfied the query criteria", "uniqueItems": true, "items": { "$ref": "#/components/schemas/Resource_Management_APIs_EmailDomain" }, "readOnly": true } }, "required": [ "items" ] } ], "example": { "totalResults": 1, "startIndex": 1, "itemsPerPage": 10, "items": [ { "id": "a4jzydksmrf3jnu5yfcwpl4a4a", "ownerType": "APPLICATION", "ownerId": "4a4aa4jzydksmrf3jnu5yfcwpl", "domainName": "mail.custom.com", "status": "VERIFIED", "dnsRecords": [ { "name": "_wb-verification.mail.custom.io", "recordType": "TXT", "value": "verification-code", "status": "VERIFIED", "isActive": true }, { "name": "mail.custom.io", "recordType": "TXT", "value": "v=spf1 include:_spf.wristband.dev ~all", "status": "VERIFIED", "isActive": true }, { "name": "wb-k1._domainkey.mail.custom.io", "recordType": "CNAME", "value": "k1.abcd.dkim.wristband.dev", "status": "VERIFIED", "isActive": true }, { "name": "wb-k2._domainkey.mail.custom.io", "recordType": "CNAME", "value": "k2.abcd.dkim.wristband.dev", "status": "VERIFIED", "isActive": false } ], "metadata": { "lastModifiedTime": "2016-06-13T19:49:31.686Z", "creationTime": "2016-06-13T19:49:31.686Z", "lastVerificationTime": "2016-06-13T19:49:31.686Z" } } ] } } }, "examples": { "Resource_Management_APIs_EmailDomainOffsetPaginatedResults": { "description": "Email Domain Offset Paginated Results JSON object.", "value": { "totalResults": 1, "startIndex": 1, "itemsPerPage": 10, "items": [ { "id": "a4jzydksmrf3jnu5yfcwpl4a4a", "ownerType": "APPLICATION", "ownerId": "4a4aa4jzydksmrf3jnu5yfcwpl", "domainName": "mail.custom.com", "status": "VERIFIED", "dnsRecords": [ { "name": "_wb-verification.mail.custom.io", "recordType": "TXT", "value": "verification-code", "status": "VERIFIED", "isActive": true }, { "name": "mail.custom.io", "recordType": "TXT", "value": "v=spf1 include:_spf.wristband.dev ~all", "status": "VERIFIED", "isActive": true }, { "name": "wb-k1._domainkey.mail.custom.io", "recordType": "CNAME", "value": "k1.abcd.dkim.wristband.dev", "status": "VERIFIED", "isActive": true }, { "name": "wb-k2._domainkey.mail.custom.io", "recordType": "CNAME", "value": "k2.abcd.dkim.wristband.dev", "status": "VERIFIED", "isActive": false } ], "metadata": { "lastModifiedTime": "2016-06-13T19:49:31.686Z", "creationTime": "2016-06-13T19:49:31.686Z", "lastVerificationTime": "2016-06-13T19:49:31.686Z" } } ] } } }, "responses": { "Resource_Management_APIs_401": { "description": "Unauthorized", "headers": { "WWW-Authenticate": { "description": "Includes details on the failed authentication condition. This header is set in accordance with the [OAuth2 specification](https://datatracker.ietf.org/doc/html/rfc6750#section-3).", "schema": { "type": "string", "example": "Bearer error=\"invalid_token\", error_description=\"The provided access token was invalid\"" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Resource_Management_APIs_api-error" }, "examples": { "code - unauthenticated": { "value": { "type": "base_error", "code": "invalid_access_token", "message": "The provided access token was invalid", "ticket": "1u0d0edhwbjsd" } } } } } }, "Resource_Management_APIs_403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Resource_Management_APIs_api-error" }, "examples": { "code - unauthorized": { "value": { "type": "base_error", "code": "unauthorized", "message": "The request failed authorization", "ticket": "11t7n71hi5e6t" } } } } } }, "Resource_Management_APIs_405": { "description": "Method Not Allowed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Resource_Management_APIs_api-error" }, "examples": { "code - method_not_supported": { "value": { "type": "base_error", "code": "method_not_supported", "message": "The specified HTTP method is not supported", "ticket": "11t7n71hi5e6t" } } } } } }, "Resource_Management_APIs_406": { "description": "Not Acceptable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Resource_Management_APIs_api-error" }, "examples": { "code - not_acceptable": { "value": { "type": "base_error", "code": "not_acceptable", "message": "The Accept header was invalid", "ticket": "11t7n71hi5e6t" } } } } } }, "Resource_Management_APIs_500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Resource_Management_APIs_api-error" }, "examples": { "code - internal_server_failure ": { "value": { "type": "base_error", "code": "internal_server_failure", "message": "An unexpected error occurred while processing the request", "ticket": "11t7n71hi5e6t" } } } } } }, "Resource_Management_APIs_503": { "description": "Service Unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Resource_Management_APIs_api-error" }, "examples": { "code - service_unavailable": { "value": { "type": "base_error", "code": "service_unavailable", "message": "The service is currently unavailable", "ticket": "11t7n71hi5e6t" } } } } } }, "Resource_Management_APIs_400-default": { "description": "Bad Request", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Resource_Management_APIs_api-error" }, { "$ref": "#/components/schemas/Resource_Management_APIs_constraint-violations-api-error" } ] }, "examples": { "code - invalid_request": { "value": { "type": "base_error", "code": "invalid_request", "message": "The request was invalid", "ticket": "11t7n71hi5e6t" } }, "code - request_constraint_violations": { "value": { "type": "constraint_violations_error", "code": "message_body_constraint_violations", "message": "The message body contained invalid fields", "ticket": "11t7n71hi5e6t", "violations": { "field1": { "code": "too_long", "constraintAttributes": { "maxLength": 10 } }, "field2": { "code": "not_null" } } } } } } } }, "Resource_Management_APIs_404-tenant-not-found": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Resource_Management_APIs_api-error" }, "examples": { "code - tenant_not_found": { "value": { "type": "base_error", "code": "tenant_not_found", "message": "Tenant could not be found", "ticket": "11t7n71hi5e6t" } } } } } } } }, "x-tagGroups": [ { "name": "Resource Management APIs", "tags": [ "Applications", "Auth Factors", "Auth Sessions", "Auth Session Policies", "Bot Detection Policies", "Custom Claims", "Custom Domains", "Email Brandings", "Email Domains", "Email Policies", "External IdP Profiles", "External IdP Tokens", "Identity Providers", "IdP Attribute Mappings", "IdP Role Mappings", "MFA Policies", "OAuth2 Clients", "Page Brandings", "Password Policies", "Permissions", "Permission Boundaries", "Permission Groups", "Refresh Tokens", "Remembered Tenants", "Roles", "Role Assignment Policies", "Signing Keys", "Tenants", "Users", "User Schemas", "Vanity Domains", "Webhook Policies", "Workflow Policies" ] } ] } ```