> ## Documentation Index > Fetch the complete documentation index at: https://docs.polymorfa.com/llms.txt > Use this file to discover all available pages before exploring further. # Get quick link state > Returns the hosted page state for a QuickLink. Public; the token in the URL is the credential. Starts the session on first read. ## OpenAPI ````yaml api-reference/features/integrate.json GET /quicklink/{token} openapi: 3.0.3 info: title: Integrate API methods version: 1.0.0 description: Task-focused integrate methods across supported Polymorfa connection types. servers: [] security: [] paths: /quicklink/{token}: get: tags: - Quicklink summary: Get quick link state description: >- Returns the hosted page state for a QuickLink. Public; the token in the URL is the credential. Starts the session on first read. operationId: nativeGetQuickLinkState parameters: - schema: type: string description: Opaque QuickLink token from the hosted URL. required: true name: token in: path description: Opaque token required by the target operation. responses: '200': description: Current QuickLink state content: application/json: schema: type: object properties: data: allOf: - $ref: '#/components/schemas/native__QuickLinkState' description: Structured data carried by this object. required: - data '400': description: Bad request — request body or params failed validation content: application/json: schema: $ref: '#/components/schemas/native__ErrorResponse' '401': description: Missing or invalid authentication token content: application/json: schema: $ref: '#/components/schemas/native__ErrorResponse' '403': description: Authenticated but not permitted (missing scope or rule violation) content: application/json: schema: $ref: '#/components/schemas/native__ErrorResponse' '404': description: Resource not found content: application/json: schema: $ref: '#/components/schemas/native__ErrorResponse' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/native__ErrorResponse' security: [] servers: - url: https://api.polymorfa.com components: schemas: native__QuickLinkState: type: object properties: id: type: string description: Identifier for this resource. status: type: string enum: - pending - opened - linked - connected - failed - cancelled description: |- Current status of this resource or operation. **Allowed values** | Value | Meaning | | --- | --- | | `pending` | Pending. | | `opened` | Opened. | | `linked` | Linked. | | `connected` | Connected. | | `failed` | Failed. | | `cancelled` | Cancelled. | expiresAt: type: string description: ISO 8601 timestamp when this resource expires. methods: type: array items: type: string enum: - qr - pairing description: |- Connection methods enabled for the widget. **Allowed item values** | Item value | Meaning | | --- | --- | | `qr` | Qr. | | `pairing` | Pairing. | defaultMethod: type: string nullable: true enum: - qr - pairing - null description: |- Specifies default method for this native quick link state. **Allowed values** | Value | Meaning | | --- | --- | | `qr` | Qr. | | `pairing` | Pairing. | | `null` | Null. | **Accepted alternatives** | Alternative | Accepted input | | --- | --- | | Alternative 1 | Type: `string`; Value `qr` or `pairing` | | Alternative 2 | `null` | businessName: type: string description: Business name shown to the customer. headline: type: string nullable: true description: |- Specifies headline for this native quick link state. **Accepted alternatives** | Alternative | Accepted input | | --- | --- | | Alternative 1 | Type: `string` | | Alternative 2 | `null` | description: type: string nullable: true description: |- Human-readable description of this resource. **Accepted alternatives** | Alternative | Accepted input | | --- | --- | | Alternative 1 | Type: `string` | | Alternative 2 | `null` | successMessage: type: string nullable: true description: |- Specifies success message for this native quick link state. **Accepted alternatives** | Alternative | Accepted input | | --- | --- | | Alternative 1 | Type: `string` | | Alternative 2 | `null` | supportUrl: type: string nullable: true description: |- URL for the support. **Accepted alternatives** | Alternative | Accepted input | | --- | --- | | Alternative 1 | Type: `string` | | Alternative 2 | `null` | privacyUrl: type: string nullable: true description: |- URL for the privacy. **Accepted alternatives** | Alternative | Accepted input | | --- | --- | | Alternative 1 | Type: `string` | | Alternative 2 | `null` | termsUrl: type: string nullable: true description: |- URL for the terms. **Accepted alternatives** | Alternative | Accepted input | | --- | --- | | Alternative 1 | Type: `string` | | Alternative 2 | `null` | theme: type: string enum: - light - dark - system description: |- Visual theme used by the widget. **Allowed values** | Value | Meaning | | --- | --- | | `light` | Light. | | `dark` | Dark. | | `system` | System. | accent: type: string nullable: true description: |- Specifies accent for this native quick link state. **Accepted alternatives** | Alternative | Accepted input | | --- | --- | | Alternative 1 | Type: `string` | | Alternative 2 | `null` | shape: type: string nullable: true enum: - square - rounded - pill - null description: >- Specifies shape for this native quick link state. **Allowed values** | Value | Meaning | | --- | --- | | `square` | Square. | | `rounded` | Rounded. | | `pill` | Pill. | | `null` | Null. | **Accepted alternatives** | Alternative | Accepted input | | --- | --- | | Alternative 1 | Type: `string`; Value `square` or `rounded` or `pill` | | Alternative 2 | `null` | radiusPx: type: number nullable: true description: |- Specifies radius px for this native quick link state. **Accepted alternatives** | Alternative | Accepted input | | --- | --- | | Alternative 1 | Type: `number` | | Alternative 2 | `null` | logoUrl: type: string nullable: true description: |- URL for the logo. **Accepted alternatives** | Alternative | Accepted input | | --- | --- | | Alternative 1 | Type: `string` | | Alternative 2 | `null` | hideWatermark: type: boolean description: Whether hide watermark. historySync: type: string enum: - ask - force_on - force_off description: |- History synchronization behavior for newly connected sessions. **Allowed values** | Value | Meaning | | --- | --- | | `ask` | Ask. | | `force_on` | Force on. | | `force_off` | Force off. | prefillPhone: type: string nullable: true description: |- Specifies prefill phone for this native quick link state. **Accepted alternatives** | Alternative | Accepted input | | --- | --- | | Alternative 1 | Type: `string` | | Alternative 2 | `null` | customer: type: boolean description: True when the link assigns the number to a Customer. session: type: object properties: status: type: string description: Current status of this resource or operation. phone: type: string nullable: true description: |- Phone number in international format. **Accepted alternatives** | Alternative | Accepted input | | --- | --- | | Alternative 1 | Type: `string` | | Alternative 2 | `null` | required: - status - phone description: Identifier of the connected Polymorfa session. qrSvg: type: string nullable: true description: >- Inline SVG of the current WhatsApp QR code, when the QR method is offered and the number is not linked yet. **Accepted alternatives** | Alternative | Accepted input | | --- | --- | | Alternative 1 | Type: `string` | | Alternative 2 | `null` | errorCode: type: string nullable: true description: |- Machine-readable error code for this native quick link state. **Accepted alternatives** | Alternative | Accepted input | | --- | --- | | Alternative 1 | Type: `string` | | Alternative 2 | `null` | required: - id - status - expiresAt - methods - defaultMethod - businessName - headline - description - successMessage - supportUrl - privacyUrl - termsUrl - theme - accent - shape - radiusPx - logoUrl - hideWatermark - historySync - prefillPhone - customer - session - qrSvg - errorCode native__ErrorResponse: type: object properties: error: type: string description: Human-readable error message docs: type: string description: URL to the documentation for this error required: - error ````