GuideLab API
Pickup Requests

Get a pickup request and its immutable history

GET
/pickup-requests/{id}

Authorization

__Secure-guidelab-prod.session_token<token>

Production session cookie set for the guidelab.co domain by Better Auth

In: cookie

Path Parameters

id*string
Length1 <= length

Response Body

application/json

curl -X GET "https://example.com/pickup-requests/string"
{  "request": {    "id": "string",    "labId": "string",    "clinicId": "string",    "partnershipId": "string",    "formRevisionId": "string",    "status": "string",    "formData": {      "property1": null,      "property2": null    },    "requestedWindowStart": "string",    "requestedWindowEnd": "string",    "requestedTimezone": "string",    "scheduledWindowStart": "string",    "scheduledWindowEnd": "string",    "scheduledTimezone": "string",    "addressId": "string",    "addressSnapshot": {      "label": "string",      "contactName": "string",      "contactPhone": "string",      "addressLine1": "string",      "addressLine2": "string",      "city": "string",      "state": "string",      "postcode": "string",      "country": "st"    },    "requestedByMemberId": "string",    "assignedMemberId": "string",    "assignedExternalName": "string",    "assignedExternalPhone": "string",    "assignedExternalEmail": "string",    "notes": "string",    "internalNotes": "string",    "collectedAt": "string",    "cancelledAt": "string",    "createdAt": "string",    "updatedAt": "string"  },  "orderIds": [    "string"  ],  "attempts": [    {      "id": "string",      "attemptNumber": 1,      "outcome": "string",      "notes": "string",      "attemptedAt": "string"    }  ],  "events": [    {      "id": "string",      "sequence": 1,      "eventType": "string",      "fromStatus": "string",      "toStatus": "string",      "payload": {        "property1": null,        "property2": null      },      "createdAt": "string"    }  ]}
Empty
Empty

Get a pickup form element by ID GET

Retrieve a single form element by its ID. Must belong to the current lab. Lab only.

Get pickup request settings GET

Retrieve pickup request form settings for the current lab, including whether the form is enabled and thank-you message configuration. Lab only.