> ## Documentation Index > Fetch the complete documentation index at: https://api-docs.useopenwrench.com/llms.txt > Use this file to discover all available pages before exploring further. # Get a walkthrough > Retrieves a single walkthrough by id. Linked work orders in task answers are permission-filtered for the caller. ## OpenAPI ````yaml /openapi/buyer.json get /v1/buyer/site_survey/walkthroughs/{id} openapi: 3.1.0 info: title: OpenWrench Buyer API version: 1.0.0 description: >- External REST API for OpenWrench buyers (facilities-management side). Generated from the application source (Play routes, controllers and models). ## Authentication Every request must carry a buyer API key in the `X-API-KEY` header. The key resolves to a buyer contact, and all reads/writes are tenant-scoped to that contact's buyer company (plus, on several endpoints, role-based location/brand restrictions). Endpoints under `/v1/buyer/super_admin/...` (and a few others noted per-operation) additionally require the key's contact to be a buyer super admin. ## Rate limiting 10 requests per 20-second window per API key; requests beyond that receive **429**. A handful of operations noted per-operation bypass the rate limiter. ## Response envelope Single-entity responses: `{ "type": "", "data": { ... }, "status": "ok" }`. List responses: `{ "type": "", "data": [ ... ], "count": , "status": "ok" }`. count_by responses: `{ "type": "CountBy", "data": , "status": "ok" }`. Errors: `{ "message": "...", "type": "", "status": "error", "traceId": "..." }` — 401 missing/invalid key, 400 bad input, 404 not found, 429 rate limit. ## Pagination & filtering List endpoints accept `offset`, `limit` (default 10, max 25 — the locations list clamps to 10), `sort_by` and `order` (asc|desc). Every other query parameter is treated as a filter and matched against the entity's indexed columns (multi-value filters are comma-separated strings); these are combined with the tenant-security filters derived from the API key. Timestamps are ISO 8601 strings unless noted otherwise. ## Date formats Date-time fields serialize as strings in one of two shapes depending on the underlying type: ISO 8601 with offset (e.g. `2026-08-14T13:05:22.000-07:00`) for most timestamps, or `yyyy-MM-dd HH:mm:ss.S` (space-separated, no offset) for database timestamp fields. Plain dates are `yyyy-MM-dd`. When sending date-times, ISO 8601 is accepted. ## Required headers Every request must carry BOTH `X-API-KEY` (your API key) and `OW-KEY` (the OpenWrench shared secret issued with it). Requests missing either return 401. servers: - url: https://api.useopenwrench.com/api/external security: - ApiKeyAuth: [] OwKeyAuth: [] tags: - name: Ping - name: Me - name: Locations - name: Regions - name: Asset Types - name: Asset Meters - name: Assets - name: Asset Labels description: Read the asset label catalog and replace the labels applied to an asset. - name: Asset Models - name: Work Orders - name: Work Order Notes - name: Work Order Labels description: >- Read your work order label catalog and replace the labels applied to a work order. - name: Service Calls - name: Site Survey Walkthroughs - name: Invoices - name: Proposals - name: Files - name: Planned Maintenance - name: Currency Exchange - name: Supplier Network - name: User Provisioning paths: /v1/buyer/site_survey/walkthroughs/{id}: get: tags: - Site Survey Walkthroughs summary: Get a walkthrough description: >- Retrieves a single walkthrough by id. Linked work orders in task answers are permission-filtered for the caller. operationId: getWalkthrough parameters: - name: id in: path required: true schema: type: integer responses: '200': description: Success. content: application/json: schema: $ref: '#/components/schemas/WalkthroughResponse' '400': description: >- Bad input, parse failure, or the API key's contact could not be resolved. content: application/json: schema: $ref: '#/components/schemas/Error' '401': description: Missing or invalid X-API-KEY. content: application/json: schema: $ref: '#/components/schemas/Error' '404': description: Not found. content: application/json: schema: $ref: '#/components/schemas/Error' '429': description: Rate limit exceeded (10 requests per 20-second window per key). content: application/json: schema: $ref: '#/components/schemas/Error' components: schemas: WalkthroughResponse: type: object properties: type: type: string description: Entity type marker, e.g. "Walkthrough". data: $ref: '#/components/schemas/Walkthrough' status: type: string enum: - ok required: - type - data - status Error: type: object properties: message: type: string type: type: string description: >- Exception type, e.g. unauthorizedException, NotFoundException, BadRequestException, ParseException, InvalidInputDataException, ConflictException, UnexpectedException. status: type: string enum: - error traceId: type: string description: >- Trace id (a random 11-char alphanumeric string when no explicit trace applies). required: - message - type - status - traceId description: >- Standard error envelope. 401 = missing/invalid API key, 400 = bad input, 404 = not found, 429 = rate limit exceeded. Walkthrough: type: object properties: id: type: - integer - 'null' title: type: string description: type: - string - 'null' status: type: string locationId: type: integer location: anyOf: - $ref: '#/components/schemas/Location' - type: 'null' siteSurveyId: type: integer projectId: type: - integer - 'null' taskAnswers: type: - array - 'null' items: type: object properties: {} additionalProperties: true description: >- Walkthrough task answer (shape abridged; may reference work orders the caller can read). scores: type: - array - 'null' items: $ref: '#/components/schemas/WalkthroughScore' notes: type: array items: $ref: '#/components/schemas/Note' fileAttachments: type: array items: $ref: '#/components/schemas/FileDetails' scheduledBy: type: - string - 'null' dueAt: type: - string - 'null' format: date-time completedAt: type: - string - 'null' format: date-time completedBy: type: - string - 'null' startTime: type: - string - 'null' format: date-time endTime: type: - string - 'null' format: date-time supplierFacilityId: type: - integer - 'null' buyerSubscriberEmails: type: array items: type: string supplierSubscriberEmails: type: array items: type: string lastNote: type: - string - 'null' lastNoteType: type: - string - 'null' lastNoteAddedBy: type: - string - 'null' lastNoteAddedAt: type: - string - 'null' format: date-time buyerCompanyId: type: integer createdBy: type: - string - 'null' pdfLink: type: - string - 'null' createdAt: type: - string - 'null' format: date-time updatedAt: type: - string - 'null' format: date-time isDeleted: type: boolean deletedAt: type: - string - 'null' format: date-time required: - title - status - locationId - siteSurveyId - buyerCompanyId - isDeleted additionalProperties: true description: >- Site survey walkthrough (read-only on this API). Abridged: hydrated site survey, project, subscriber contact objects may also appear. The embedded siteSurvey carries walkthroughHeatMapRanges (array of {color, lowerRange} color bands for rendering walkthrough scores); a survey with no ranges of its own is returned with its template's ranges already filled in. Location: type: object properties: id: type: - integer - 'null' storeId: type: - string - 'null' name: type: string brandId: type: - integer - 'null' brandAssetGroupId: type: - integer - 'null' allAssetCount: type: - integer - 'null' description: type: - string - 'null' isActive: type: boolean openDate: type: - string - 'null' format: date-time closeDate: type: - string - 'null' format: date-time operatingHours: anyOf: - $ref: '#/components/schemas/OperatingHours' - type: 'null' phoneNumber: type: - string - 'null' locationTypeId: type: integer locationTypeDetails: type: array items: $ref: '#/components/schemas/FieldTypeDetails' notes: type: - string - 'null' notesNonFormatted: type: - string - 'null' internalNotes: type: - string - 'null' images: type: array items: type: string internalAttachments: type: array items: $ref: '#/components/schemas/FileDetails' primaryContactsEmails: type: array items: type: string facilityInChargeEmails: type: array items: type: string sendApprovedInvoicesToEmails: type: array items: type: string sendApprovedQuotesToEmails: type: array items: type: string storeAssociateEmails: type: array items: type: string fieldTechEmails: type: array items: type: string timeZoneId: type: - string - 'null' hasPresetAssetUUID: type: - boolean - 'null' regionId: type: - integer - 'null' region: anyOf: - $ref: '#/components/schemas/Region' - type: 'null' purchaseOrderPrefix: type: - string - 'null' isLeased: type: - boolean - 'null' leaseStartDate: type: - string - 'null' format: date-time leaseEndDate: type: - string - 'null' format: date-time taxRate: type: - string - 'null' customFieldDetails: type: - array - 'null' items: $ref: '#/components/schemas/FieldTypeDetails' buildingWarrantyStartDate: type: - string - 'null' format: date-time buildingWarrantyExpirationDate: type: - string - 'null' format: date-time buildingWarrantyProblemTypeIds: type: - array - 'null' items: type: integer buildingWarrantyServiceProviderId: type: - integer - 'null' invoicesBillTo: anyOf: - $ref: '#/components/schemas/InvoicesBillTo' - type: 'null' countryCode: type: - string - 'null' buyerFacilityId: type: integer buyerCompanyId: type: integer totalWOCount: type: - integer - 'null' totalNotClosedWOCount: type: - integer - 'null' createdAt: type: - string - 'null' format: date-time updatedAt: type: - string - 'null' format: date-time isDeleted: type: boolean deletedAt: type: - string - 'null' format: date-time required: - name - isActive - locationTypeId - buyerFacilityId - buyerCompanyId - isDeleted additionalProperties: true description: >- Location. Abridged: hydrated contact/settings arrays and brand/facility/company objects may also appear in responses. WalkthroughScore: type: object properties: walkthroughName: type: string locationName: type: - string - 'null' createdBy: type: - string - 'null' createdAt: type: - string - 'null' format: date-time completedAt: type: - string - 'null' format: date-time groupTitle: type: - string - 'null' totalQuestionsCount: type: - integer - 'null' questionsAnsweredCount: type: - integer - 'null' score: type: - integer - 'null' medianScore: type: - string - 'null' averageScore: type: - string - 'null' minPossibleScore: type: - integer - 'null' maxPossibleScore: type: - integer - 'null' percentageScoreByMaxPossibleScore: type: - string - 'null' percentageScore: type: - string - 'null' required: - walkthroughName Note: type: object properties: text: type: string photo: type: - string - 'null' video: type: - string - 'null' audio: type: - string - 'null' otherFile: type: - string - 'null' noteAddedBy: type: string description: Email of the note author. noteAddedAt: type: string format: date-time elements: type: - array - 'null' items: $ref: '#/components/schemas/NoteElement' noteReadDetails: type: - array - 'null' items: $ref: '#/components/schemas/NoteReadDetail' noteAddedByContact: anyOf: - $ref: '#/components/schemas/Contact' - type: 'null' noteType: type: - string - 'null' noteAddedByType: type: - string - 'null' usersActiveInChat: type: - array - 'null' items: type: string s3EmailReference: type: - string - 'null' s3EmailReferenceUrl: type: - string - 'null' caption: type: - string - 'null' captionSource: type: - string - 'null' captionModel: type: - string - 'null' captionGenerationAttempted: type: - boolean - 'null' isNoteAwaitingResponse: type: - boolean - 'null' isAudioTranslated: type: - boolean - 'null' isAudioTranscriptionError: type: - boolean - 'null' siteSurveyTaskTitleId: type: - string - 'null' id: type: - integer - 'null' description: >- Per-note row id (populated on read where the note store is normalized). required: - text - noteAddedBy - noteAddedAt FileDetails: type: object properties: fileName: type: string description: Original file name (non-ASCII characters stripped on upload). fileId: type: string description: Opaque file identifier used for later download. required: - fileName - fileId description: 'File reference: name plus storage identifier.' OperatingHours: type: object properties: timeZoneId: type: - string - 'null' timeZoneName: type: - string - 'null' Monday: anyOf: - $ref: '#/components/schemas/Timings' - type: 'null' Tuesday: anyOf: - $ref: '#/components/schemas/Timings' - type: 'null' Wednesday: anyOf: - $ref: '#/components/schemas/Timings' - type: 'null' Thursday: anyOf: - $ref: '#/components/schemas/Timings' - type: 'null' Friday: anyOf: - $ref: '#/components/schemas/Timings' - type: 'null' Saturday: anyOf: - $ref: '#/components/schemas/Timings' - type: 'null' Sunday: anyOf: - $ref: '#/components/schemas/Timings' - type: 'null' FieldTypeDetails: type: object properties: key: type: string valueAsString: type: string valueType: type: string required: - key - valueAsString - valueType Region: type: object properties: id: type: - integer - 'null' name: type: string buyerCompanyId: type: integer hierarchyName: type: - string - 'null' parentId: type: - integer - 'null' hasChildren: type: boolean createdAt: type: - string - 'null' format: date-time updatedAt: type: - string - 'null' format: date-time isDeleted: type: boolean deletedAt: type: - string - 'null' format: date-time required: - name - buyerCompanyId - hasChildren - isDeleted InvoicesBillTo: type: object properties: billTo: type: string serviceAddress: type: object properties: {} additionalProperties: true required: - billTo - serviceAddress NoteElement: type: object properties: type: type: string enum: - text - user value: type: string userObject: anyOf: - $ref: '#/components/schemas/Contact' - type: 'null' required: - type - value NoteReadDetail: type: object properties: readAt: type: string format: date-time readBy: type: string readByContact: anyOf: - $ref: '#/components/schemas/Contact' - type: 'null' required: - readAt - readBy Contact: type: object properties: email: type: string nameGiven: type: string nameFamily: type: string title: type: - string - 'null' department: type: - string - 'null' facilityId: type: - integer - 'null' contactType: type: string description: '"buyer" or "supplier".' isSharedContact: type: boolean readOnlyAccess: type: - boolean - 'null' invitedByEmail: type: - string - 'null' invitedAt: type: - string - 'null' format: date-time invitedByName: type: - string - 'null' epaCertificationType: type: - string - 'null' epaCertificationNumber: type: - string - 'null' createdAt: type: - string - 'null' format: date-time updatedAt: type: - string - 'null' format: date-time required: - email - nameGiven - nameFamily - contactType additionalProperties: true description: >- Contact record. Abridged: only fields observed in the provided sources are listed. Timings: type: object properties: {} additionalProperties: true description: Opening/closing timings for one weekday. Shape abridged. securitySchemes: ApiKeyAuth: type: apiKey in: header name: X-API-KEY OwKeyAuth: type: apiKey in: header name: OW-KEY description: >- OpenWrench shared secret. Required on every request alongside X-API-KEY; issued together with your API key. ````