> ## Documentation Index > Fetch the complete documentation index at: https://docs-v2.sortx.co.uk/llms.txt > Use this file to discover all available pages before exploring further. # Current voids > Current voids: every open void with days empty, stage, works spent of approved, target ready day and what is holding it up, with the board's totals ## OpenAPI ````yaml /openapi.json get /handovers/voids openapi: 3.1.0 info: title: SortX API version: 1.0.0 description: >- Reactive repairs, planned maintenance, compliance and the repairs desk for UK letting agents and property managers. servers: - url: https://api.sortx.co.uk description: Production security: [] tags: - name: tenants - name: entitlements - name: events - name: workspace-settings - name: operational-catalogues - name: money - name: contacts - name: properties - name: address-lookup - name: tenancies - name: contractor-invoices - name: keys - name: inspections - name: handovers - name: planned-maintenance - name: contractors - name: company-onboarding - name: documents - name: compliance - name: activity - name: tasks - name: today - name: desk - name: people - name: property-boards - name: reports - name: workspace-search - name: calendar - name: telephony - name: maintenance-pro - name: front-desk - name: maintenance-pro-public - name: maintenance-pro-contractor paths: /handovers/voids: get: tags: - handovers summary: Current voids description: >- Current voids: every open void with days empty, stage, works spent of approved, target ready day and what is holding it up, with the board's totals operationId: handovers.currentVoids parameters: [] responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/CurrentVoidsBoardRow' '400': description: >- TenantCreateRejected | ConfigMissing | IntegrationRejected | AuthRejected | RegistrationRejected | UnknownIntegration | WebhookUnroutable | RateUnavailable content: application/json: schema: anyOf: - $ref: '#/components/schemas/TenantCreateRejectedEncoded' - $ref: '#/components/schemas/ConfigMissingEncoded' - $ref: '#/components/schemas/IntegrationRejectedEncoded' - $ref: '#/components/schemas/AuthRejectedEncoded' - $ref: '#/components/schemas/RegistrationRejectedEncoded' - $ref: '#/components/schemas/UnknownIntegrationEncoded' - $ref: '#/components/schemas/WebhookUnroutableEncoded' - $ref: '#/components/schemas/RateUnavailableEncoded' - $ref: '#/components/schemas/HandoverInputInvalid' '401': description: Unauthenticated | WebhookRejected | ApiKeyRejected content: application/json: schema: anyOf: - $ref: '#/components/schemas/UnauthenticatedEncoded' - $ref: '#/components/schemas/WebhookRejectedEncoded' - $ref: '#/components/schemas/ApiKeyRejectedEncoded' '402': description: TenantSuspended | PlanRequired content: application/json: schema: anyOf: - $ref: '#/components/schemas/TenantSuspendedEncoded' - $ref: '#/components/schemas/PlanRequiredEncoded' '403': description: >- EntitlementMissing | NotAMember | ScopeUnknown | ScopeMissing | TenantMismatch | WorkspaceOwnerRequired | WorkspaceRoleRequired content: application/json: schema: anyOf: - $ref: '#/components/schemas/EntitlementMissingEncoded' - $ref: '#/components/schemas/NotAMemberEncoded' - $ref: '#/components/schemas/ScopeUnknownEncoded' - $ref: '#/components/schemas/ScopeMissingEncoded' - $ref: '#/components/schemas/TenantMismatchEncoded' - $ref: '#/components/schemas/WorkspaceOwnerRequiredEncoded' - $ref: '#/components/schemas/WorkspaceRoleRequiredEncoded' '404': description: TenantNotFound | ModuleRequestNotFound content: application/json: schema: anyOf: - $ref: '#/components/schemas/TenantNotFoundEncoded' - $ref: '#/components/schemas/ModuleRequestNotFoundEncoded' - $ref: '#/components/schemas/VoidNotFound' '409': description: WebhookDuplicate | RegistrationConflict | MoneyBusy content: application/json: schema: anyOf: - $ref: '#/components/schemas/WebhookDuplicateEncoded' - $ref: '#/components/schemas/RegistrationConflictEncoded' - $ref: '#/components/schemas/MoneyBusyEncoded' '429': description: RateLimited content: application/json: schema: $ref: '#/components/schemas/RateLimitedEncoded' '503': description: IntegrationUnavailable content: application/json: schema: $ref: '#/components/schemas/IntegrationUnavailableEncoded' security: - apiKey: [] components: schemas: CurrentVoidsBoardRow: type: object properties: today: type: string targetDays: anyOf: - type: number - type: string enum: - Infinity - '-Infinity' - NaN kpis: type: object properties: count: anyOf: - type: number - type: string enum: - Infinity - '-Infinity' - NaN averageDays: anyOf: - type: number - type: string enum: - Infinity - '-Infinity' - NaN late: anyOf: - type: number - type: string enum: - Infinity - '-Infinity' - NaN spentMinor: anyOf: - type: number - type: string enum: - Infinity - '-Infinity' - NaN approvedMinor: anyOf: - type: number - type: string enum: - Infinity - '-Infinity' - NaN required: - count - averageDays - late - spentMinor - approvedMinor additionalProperties: false rows: type: array items: $ref: '#/components/schemas/VoidRow' required: - today - targetDays - kpis - rows additionalProperties: false TenantCreateRejectedEncoded: type: object properties: _tag: type: string enum: - TenantCreateRejected reason: type: string field: anyOf: - type: string - type: 'null' required: - _tag - reason additionalProperties: false ConfigMissingEncoded: type: object properties: _tag: type: string enum: - ConfigMissing key: type: string required: - _tag - key additionalProperties: false IntegrationRejectedEncoded: type: object properties: _tag: type: string enum: - IntegrationRejected integration: type: string reason: type: string required: - _tag - integration - reason additionalProperties: false AuthRejectedEncoded: type: object properties: _tag: type: string enum: - AuthRejected code: type: string message: type: string required: - _tag - code - message additionalProperties: false RegistrationRejectedEncoded: type: object properties: _tag: type: string enum: - RegistrationRejected message: type: string field: anyOf: - type: string - type: 'null' required: - _tag - message additionalProperties: false UnknownIntegrationEncoded: type: object properties: _tag: type: string enum: - UnknownIntegration integration: type: string required: - _tag - integration additionalProperties: false WebhookUnroutableEncoded: type: object properties: _tag: type: string enum: - WebhookUnroutable integration: type: string reason: type: string required: - _tag - integration - reason additionalProperties: false RateUnavailableEncoded: type: object properties: _tag: type: string enum: - RateUnavailable base: type: string quote: type: string 'on': type: string required: - _tag - base - quote - 'on' additionalProperties: false HandoverInputInvalid: type: object properties: _tag: type: string enum: - HandoverInputInvalid field: type: string message: type: string required: - _tag - field - message additionalProperties: false UnauthenticatedEncoded: type: object properties: _tag: type: string enum: - Unauthenticated required: - _tag additionalProperties: false WebhookRejectedEncoded: type: object properties: _tag: type: string enum: - WebhookRejected integration: type: string reason: type: string required: - _tag - integration - reason additionalProperties: false ApiKeyRejectedEncoded: type: object properties: _tag: type: string enum: - ApiKeyRejected required: - _tag additionalProperties: false TenantSuspendedEncoded: type: object properties: _tag: type: string enum: - TenantSuspended tenantId: type: string reason: type: string required: - _tag - tenantId - reason additionalProperties: false PlanRequiredEncoded: type: object properties: _tag: type: string enum: - PlanRequired tenantId: type: string required: - _tag - tenantId additionalProperties: false EntitlementMissingEncoded: type: object properties: _tag: type: string enum: - EntitlementMissing tenantId: type: string moduleId: type: string required: - _tag - tenantId - moduleId additionalProperties: false NotAMemberEncoded: type: object properties: _tag: type: string enum: - NotAMember userId: type: string slug: type: string required: - _tag - userId - slug additionalProperties: false ScopeUnknownEncoded: type: object properties: _tag: type: string enum: - ScopeUnknown scope: type: string required: - _tag - scope additionalProperties: false ScopeMissingEncoded: type: object properties: _tag: type: string enum: - ScopeMissing scope: type: string required: - _tag - scope additionalProperties: false TenantMismatchEncoded: type: object properties: _tag: type: string enum: - TenantMismatch header: type: string organizationId: type: string required: - _tag - header - organizationId additionalProperties: false WorkspaceOwnerRequiredEncoded: type: object properties: _tag: type: string enum: - WorkspaceOwnerRequired required: - _tag additionalProperties: false WorkspaceRoleRequiredEncoded: type: object properties: _tag: type: string enum: - WorkspaceRoleRequired role: anyOf: - type: string - type: 'null' required: type: array items: type: string message: type: string required: - _tag - role - required - message additionalProperties: false TenantNotFoundEncoded: type: object properties: _tag: type: string enum: - TenantNotFound slug: type: string required: - _tag - slug additionalProperties: false ModuleRequestNotFoundEncoded: type: object properties: _tag: type: string enum: - ModuleRequestNotFound id: type: string required: - _tag - id additionalProperties: false VoidNotFound: type: object properties: _tag: type: string enum: - VoidNotFound voidId: type: string required: - _tag - voidId additionalProperties: false WebhookDuplicateEncoded: type: object properties: _tag: type: string enum: - WebhookDuplicate integration: type: string externalId: type: string required: - _tag - integration - externalId additionalProperties: false RegistrationConflictEncoded: type: object properties: _tag: type: string enum: - RegistrationConflict message: type: string field: anyOf: - type: string - type: 'null' required: - _tag - message additionalProperties: false MoneyBusyEncoded: type: object properties: _tag: type: string enum: - MoneyBusy message: type: string required: - _tag - message additionalProperties: false RateLimitedEncoded: type: object properties: _tag: type: string enum: - RateLimited key: type: string retryAfterSeconds: anyOf: - type: number - type: string enum: - Infinity - '-Infinity' - NaN message: type: string required: - _tag - key - retryAfterSeconds - message additionalProperties: false IntegrationUnavailableEncoded: type: object properties: _tag: type: string enum: - IntegrationUnavailable integration: type: string detail: anyOf: - type: string - type: 'null' required: - _tag - integration additionalProperties: false VoidRow: type: object properties: id: type: string propertyId: type: string unitId: anyOf: - type: string - type: 'null' label: anyOf: - type: string - type: 'null' sourceTenancyId: anyOf: - type: string - type: 'null' landlord: anyOf: - type: object properties: contactId: type: string name: anyOf: - type: string - type: 'null' required: - contactId - name additionalProperties: false - type: 'null' emptySince: type: string days: anyOf: - type: number - type: string enum: - Infinity - '-Infinity' - NaN targetReadyOn: type: string late: type: boolean stage: type: string enum: - inspection - works - clean - compliance - ready stageIndex: anyOf: - type: number - type: string enum: - Infinity - '-Infinity' - NaN stageLabel: type: string status: type: string enum: - open - closed outcome: anyOf: - type: string enum: - let - landlord - sold - type: 'null' outcomeLabel: anyOf: - type: string - type: 'null' closedOn: anyOf: - type: string - type: 'null' closedAt: anyOf: - type: string - type: 'null' closedByUserId: anyOf: - type: string - type: 'null' holdingUpNote: anyOf: - type: string - type: 'null' holdingUp: anyOf: - type: string - type: 'null' budget: type: object properties: committedMinor: anyOf: - type: number - type: string enum: - Infinity - '-Infinity' - NaN approvedMinor: anyOf: - type: number - type: string enum: - Infinity - '-Infinity' - NaN leftMinor: anyOf: - type: number - type: string enum: - Infinity - '-Infinity' - NaN over: type: boolean overByMinor: anyOf: - type: number - type: string enum: - Infinity - '-Infinity' - NaN percent: anyOf: - type: number - type: string enum: - Infinity - '-Infinity' - NaN required: - committedMinor - approvedMinor - leftMinor - over - overByMinor - percent additionalProperties: false works: anyOf: - type: array items: type: object properties: repairId: type: string reference: anyOf: - type: string - type: 'null' title: type: string kind: type: string purpose: type: string enum: - works - clean - gas_safety - eicr - epc - alarms_tested contractorName: anyOf: - type: string - type: 'null' status: type: string enum: - awaiting_quote - booked - in_progress - done - blocked statusLabel: type: string costMinor: anyOf: - anyOf: - type: number - type: string enum: - Infinity - '-Infinity' - NaN - type: 'null' blockedNote: anyOf: - type: string - type: 'null' visitOn: anyOf: - type: string - type: 'null' required: - repairId - reference - title - kind - purpose - contractorName - status - statusLabel - costMinor - blockedNote - visitOn additionalProperties: false - type: 'null' taskCount: anyOf: - type: number - type: string enum: - Infinity - '-Infinity' - NaN openTaskCount: anyOf: - type: number - type: string enum: - Infinity - '-Infinity' - NaN checks: type: array items: type: object properties: check: type: string enum: - works_done - deep_clean - gas_safety - eicr - epc - alarms_tested - listing_photos - keys_back label: type: string state: type: string enum: - pass - fail - wait note: anyOf: - type: string - type: 'null' manual: type: boolean required: - check - label - state - note - manual additionalProperties: false checksPassed: anyOf: - type: number - type: string enum: - Infinity - '-Infinity' - NaN checksTotal: anyOf: - type: number - type: string enum: - Infinity - '-Infinity' - NaN readyToLet: type: boolean landlordAsk: anyOf: - type: object properties: repairId: type: string amountMinor: anyOf: - type: number - type: string enum: - Infinity - '-Infinity' - NaN askedAt: type: string approved: type: boolean required: - repairId - amountMinor - askedAt - approved additionalProperties: false - type: 'null' revision: anyOf: - type: number - type: string enum: - Infinity - '-Infinity' - NaN required: - id - propertyId - unitId - label - sourceTenancyId - landlord - emptySince - days - targetReadyOn - late - stage - stageIndex - stageLabel - status - outcome - outcomeLabel - closedOn - closedAt - closedByUserId - holdingUpNote - holdingUp - budget - works - taskCount - openTaskCount - checks - checksPassed - checksTotal - readyToLet - landlordAsk - revision additionalProperties: false securitySchemes: apiKey: type: apiKey in: header name: x-api-key description: >- A workspace API key (Settings → API keys), scoped to `:read` / `:write`. ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.