> ## Documentation Index > Fetch the complete documentation index at: https://docs.closient.com/llms.txt > Use this file to discover all available pages before exploring further. # Custom-hostname onboarding nudge > Whether to recommend a custom hostname to this organization (true once it has minted a long-lived asset identifier and has no verified hostname yet), with the copy to show. Requires VIEW permission. ## OpenAPI ````yaml /openapi/openapi-resolver.json get /resolver/api/v1/organizations/{organization_id}/custom-hostname-nudge openapi: 3.1.0 info: title: Resolver API version: 1.0.0 description: > GS1 Digital Link resolution with content negotiation and linkset support. ## Authentication All endpoints require an API key passed via the `X-API-Key` HTTP header, unless otherwise noted. ``` X-API-Key: csb__ ``` Generate API keys in **Settings > API Keys** in your dashboard, or via the Account API. Session-based (cookie) authentication is also accepted for browser-based access. ## Rate Limits | Tier | Requests / minute | Requests / day | |-------------|-------------------|----------------| | Default | 300 | 10,000 | | Custom | Contact us | Contact us | Rate-limit headers are included on every response so callers can self-throttle without hitting our 429s ("informed governor"): - `RateLimit-Policy` — every active window, e.g. `300;w=60, 10000;w=86400` - `RateLimit-Limit` — quota for the **most-restrictive** currently-active window - `RateLimit-Remaining` — requests left in that window - `RateLimit-Reset` — seconds until that window resets (relative; clock-skew safe) Legacy `X-RateLimit-*` aliases are also emitted for back-compat. `X-RateLimit-Reset` keeps the absolute Unix-timestamp shape to avoid breaking existing consumers. When rate-limited, you receive `429 Too Many Requests` with a `retry_after_seconds` field in the error envelope and a `Retry-After` header. ## Pagination List endpoints return paginated results in this envelope: ```json { "data": [...], "pagination": { "page": 1, "page_size": 25, "total_count": 342, "total_pages": 14, "has_next": true, "has_previous": false } } ``` Use `?page=2&page_size=50` query parameters. Maximum page size is 100. ## Error Responses All errors conform to [RFC 9457 Problem Details](https://www.rfc-editor.org/rfc/rfc9457) with `Content-Type: application/problem+json`: ```json { "type": "https://closient.com/docs/errors/not_found", "title": "Not Found", "status": 404, "detail": "The requested resource was not found.", "error_code": "not_found", "retryable": false, "timestamp": "2026-03-31T12:00:00+00:00" } ``` Common error codes: `unauthorized` (401), `forbidden` (403), `not_found` (404), `validation_error` (422), `rate_limited` (429), `internal_error` (500). termsOfService: https://www.closient.com/terms/ servers: - url: https://www.closient.com security: [] tags: - name: Resolver description: GS1 Digital Link resolution with content negotiation and linkset support. - name: Custom URLs description: >- Reusable custom-URL catalog (C-3339) — create, list, edit, and delete the custom redirect destinations that resolution rules point at. - name: Verification description: >- Serial verification (`gs1:verificationService`) — tiered, rate-limited responses for serialized GTIN scans. Experimental v1; see the verification-service guide. - name: Resolver Custom Hostnames description: >- BYO domain (C-4058) — register a customer-owned hostname, publish the CNAME records, verify ownership, and serve an org's Digital Link QRs from its own DNS. externalDocs: description: Closient Documentation url: https://docs.closient.com paths: /resolver/api/v1/organizations/{organization_id}/custom-hostname-nudge: get: tags: - Resolver Custom Hostnames summary: Custom-hostname onboarding nudge description: >- Whether to recommend a custom hostname to this organization (true once it has minted a long-lived asset identifier and has no verified hostname yet), with the copy to show. Requires VIEW permission. operationId: apps_resolver_api_custom_hostnames_hostname_nudge parameters: - in: path name: organization_id schema: description: Organization UUID. format: shortuuid maxLength: 22 minLength: 22 pattern: ^[23456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{22}$ title: Organization Id type: string required: true description: Organization UUID. responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/CustomHostnameNudgeOut' '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/ErrorOut' security: - APIKeyHeaderAuth: [] - OAuthTokenAuth: [] - SessionAuth: [] components: schemas: CustomHostnameNudgeOut: examples: - exit_story: >- It is strongly recommended, never required — and reversible. If you ever leave Closient, repoint the CNAME; the identifiers keep working. headline: Serve your asset QRs from your own domain rationale: >- Asset labels can outlive their packaging by decades. Pointing a hostname you own (e.g. id.yourco.com) at Closient makes those identifiers permanent in your DNS, not ours. recommended: true properties: recommended: description: Whether to surface the custom-hostname recommendation. title: Recommended type: boolean headline: anyOf: - type: string - type: 'null' description: Short nudge headline, or null when not recommended. title: Headline rationale: anyOf: - type: string - type: 'null' description: Why a custom hostname matters, or null. title: Rationale exit_story: anyOf: - type: string - type: 'null' description: The anti-lock-in framing, or null. title: Exit Story required: - recommended title: CustomHostnameNudgeOut type: object ErrorOut: description: |- RFC 9457 Problem Details response. All API errors are returned in this format with Content-Type: application/problem+json. examples: - detail: The requested resource was not found. error_code: not_found retryable: false status: 404 timestamp: '2026-03-31T12:00:00+00:00' title: Not Found type: https://closient.com/docs/errors/not_found - detail: Validation error. details: - loc: - body - name msg: Field required type: missing error_code: validation_error retryable: false status: 422 timestamp: '2026-03-31T12:00:00+00:00' title: Validation Error type: https://closient.com/docs/errors/validation_error - detail: Rate limit exceeded. Please try again later. error_code: rate_limited retry_after: 31 retryable: true status: 429 timestamp: '2026-03-31T12:00:00+00:00' title: Rate Limited type: https://closient.com/docs/errors/rate_limited properties: type: description: URI reference identifying the error type. title: Type type: string title: description: Short human-readable summary of the error. title: Title type: string status: description: HTTP status code. title: Status type: integer detail: description: Human-readable explanation of this specific occurrence. title: Detail type: string error_code: description: Machine-readable error code (e.g. not_found, unauthorized). title: Error Code type: string retryable: default: false description: Whether retrying the same request can succeed. title: Retryable type: boolean timestamp: description: ISO 8601 timestamp of when the error occurred. title: Timestamp type: string retry_after: anyOf: - type: integer - type: 'null' description: Seconds to wait before retrying (when applicable). title: Retry After owner_action_required: anyOf: - type: boolean - type: 'null' description: Whether the error requires account owner intervention. title: Owner Action Required details: description: Additional context (validation errors, etc.). title: Details required: - type - title - status - detail - error_code - timestamp title: ErrorOut type: object securitySchemes: APIKeyHeaderAuth: type: apiKey in: header name: X-API-Key OAuthTokenAuth: type: http scheme: bearer SessionAuth: type: apiKey in: cookie name: sessionid ````