> ## Documentation Index > Fetch the complete documentation index at: https://docs.intermezzo.ai/llms.txt > Use this file to discover all available pages before exploring further. # Get NEST connection status > The organisation's NEST connection (null when not connected) and its latest setup, link or verify operation. ## OpenAPI ````yaml /api-reference/preview.json get /gb/organizations/{organization_id}/pension/nest/status openapi: 3.2.0 info: title: Intermezzo Global Payroll summary: Global Payroll Platform description: Intermezzo's global payroll apis, organized by country version: '2026-10-07' x-logo: url: /static/icon.svg servers: - url: https://preview.intermezzo.ai description: Preview security: [] paths: /gb/organizations/{organization_id}/pension/nest/status: get: tags: - Great Britain - Pension - NEST summary: Get NEST connection status description: >- The organisation's NEST connection (null when not connected) and its latest setup, link or verify operation. operationId: nest_status_gb_organizations__organization_id__pension_nest_status_get parameters: - name: organization_id in: path required: true schema: type: string title: Organization Id responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/NestStatusResponse' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - BearerToken: [] components: schemas: NestStatusResponse: properties: connection: anyOf: - $ref: '#/components/schemas/NestConnection' - type: 'null' description: The organisation's NEST employer; null when not connected last_operation: anyOf: - $ref: '#/components/schemas/NestLastOperation' - type: 'null' description: The latest setup, link or verify, whatever its outcome type: object title: NestStatusResponse HTTPValidationError: properties: detail: items: $ref: '#/components/schemas/ValidationError' type: array title: Detail type: object title: HTTPValidationError NestConnection: properties: employer_reference_number: type: string title: Employer Reference Number readiness: $ref: '#/components/schemas/NestReadiness' description: >- READY when NEST reported the employer active with at least one group and one payment source at the last check; otherwise AWAITING_EMPLOYER employer_status: anyOf: - $ref: '#/components/schemas/NestEmployerStatus' - type: 'null' description: >- NEST EmployerStatus at the last check: A = active, D = draft (set-up not finished), UNKNOWN = a code not recognised yet verified_at: anyOf: - type: string format: date-time - type: 'null' title: Verified At description: When NEST last reported this employer's setup groups: items: $ref: '#/components/schemas/NestGroup' type: array title: Groups payment_sources: items: $ref: '#/components/schemas/NestPaymentSource' type: array title: Payment Sources type: object required: - employer_reference_number - readiness title: NestConnection NestLastOperation: properties: submission_id: type: string title: Submission Id mode: $ref: '#/components/schemas/NestOperationMode' status: $ref: '#/components/schemas/NestSubmissionStatus' error_code: anyOf: - type: string - type: 'null' title: Error Code description: >- When FAILED: a NEST_* code naming what went wrong (NEST_DELEGATE_ACCESS_DENIED: the employer has not granted our delegate access), or another HTTP status from NEST error_detail: anyOf: - type: string - type: 'null' title: Error Detail description: 'When FAILED: NEST''s error codes and messages, or our reason' type: object required: - submission_id - mode - status title: NestLastOperation ValidationError: properties: loc: items: anyOf: - type: string - type: integer type: array title: Location msg: type: string title: Message type: type: string title: Error Type type: object required: - loc - msg - type title: ValidationError NestReadiness: type: string enum: - AWAITING_EMPLOYER - READY title: NestReadiness description: >- Whether an organisation's NEST employer can be used, per the last check with NEST. NestEmployerStatus: type: string enum: - A - D - UNKNOWN title: NestEmployerStatus description: >- NEST's EmployerStatus code, as returned by Retrieve Current Setup Details. Only A and D have been seen; any other code is recorded as UNKNOWN (the raw value stays in the NEST response kept on the pension provider audit trail). NestGroup: properties: name: type: string title: Name frequency: anyOf: - type: string - type: 'null' title: Frequency eped: anyOf: - type: string format: date - type: 'null' title: Eped due_date_basis: anyOf: - type: string - type: 'null' title: Due Date Basis relative_days_after_eped: anyOf: - type: integer - type: 'null' title: Relative Days After Eped specific_day: anyOf: - type: string - type: 'null' title: Specific Day specific_day_eped_or_after: anyOf: - type: string - type: 'null' title: Specific Day Eped Or After type: object required: - name title: NestGroup description: A NEST worker group, as returned by Retrieve Current Setup Details. NestPaymentSource: properties: name: type: string title: Name contribution_payment_type: anyOf: - type: string - type: 'null' title: Contribution Payment Type type: object required: - name title: NestPaymentSource description: A NEST payment source, as returned by Retrieve Current Setup Details. NestOperationMode: type: string enum: - SETUP - LINK - VERIFY title: NestOperationMode description: What one NEST_EMPLOYER FSM does. NestSubmissionStatus: type: string enum: - PENDING - SUCCESS - FAILED title: NestSubmissionStatus securitySchemes: BearerToken: type: http scheme: bearer bearerFormat: JWT description: Get token from Auth0 and paste it here ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.