Skip to main content
GET
Get service request

Authorizations

Authorization
string
header
required

User JWT bearer token. User principals can manage API keys and call tenant-scoped customer endpoints.

Path Parameters

id
string
required

Unique identifier (UUID)

Pattern: ^[\da-f]{8}-[\da-f]{4}-[\da-f]{4}-[\da-f]{4}-[\da-f]{12}$

Response

200 - application/json

OK

id
string
required

Unique identifier (UUID)

Pattern: ^[\da-f]{8}-[\da-f]{4}-[\da-f]{4}-[\da-f]{4}-[\da-f]{12}$
referenceNumber
string
required
conversationId
string | null
required

Unique identifier (UUID)

Pattern: ^[\da-f]{8}-[\da-f]{4}-[\da-f]{4}-[\da-f]{4}-[\da-f]{12}$
voiceCallId
string | null
required

Unique identifier (UUID)

Pattern: ^[\da-f]{8}-[\da-f]{4}-[\da-f]{4}-[\da-f]{4}-[\da-f]{12}$
contactId
string | null
required

Unique identifier (UUID)

Pattern: ^[\da-f]{8}-[\da-f]{4}-[\da-f]{4}-[\da-f]{4}-[\da-f]{12}$
excludedFromReporting
boolean
required
manuallyExcludedFromReporting
boolean
required
instantBooking
boolean
required
instantBookingFallbackReasonCode
enum<string> | null
required
Available options:
required_fields_missing,
outside_booking_window,
address_invalid,
address_resolution_unavailable,
outside_service_area,
existing_customer_not_found,
identity_ambiguous,
provider_failure,
partial_provider_write,
unknown
customerName
string | null
required
firstName
string | null
required
lastName
string | null
required
phoneNumber
string
required
serviceAddress
string | null
required
serviceAddressLine1
string | null
required
serviceAddressLine2
string | null
required
serviceCity
string | null
required
serviceState
string | null
required
serviceZipCode
string | null
required
jobTypeId
string | null
required

Unique identifier (UUID)

Pattern: ^[\da-f]{8}-[\da-f]{4}-[\da-f]{4}-[\da-f]{4}-[\da-f]{12}$
jobTypeName
string | null
required
jobClassName
string | null
required
onlineBookingFormId
string | null
required

Unique identifier (UUID)

Pattern: ^[\da-f]{8}-[\da-f]{4}-[\da-f]{4}-[\da-f]{4}-[\da-f]{12}$
bookingFormSubmissionId
string | null
required

Unique identifier (UUID)

Pattern: ^[\da-f]{8}-[\da-f]{4}-[\da-f]{4}-[\da-f]{4}-[\da-f]{12}$
jobTypeFreetext
string | null
required
availabilityWindows
object[]
required
serviceNeeded
string | null
required
emailAddress
string | null
required
preferredTimeWindow
string | null
required
isExistingCustomer
boolean | null
required
channel
enum<string> | null
required
Available options:
web_chat,
voice_call,
booking_form
leadSourceId
string | null
required

Unique identifier (UUID)

Pattern: ^[\da-f]{8}-[\da-f]{4}-[\da-f]{4}-[\da-f]{4}-[\da-f]{12}$
leadSourceName
string | null
required
conversationSummary
string | null
required
customFields
object
required
status
enum<string>
required
Available options:
needs_info,
ready_to_schedule,
scheduled,
completed,
canceled
createdAt
string
required
updatedAt
string | null
required
fsmJobLeadGuid
string | null
required
fsmRecord
object
required
bookingDetails
object | null
required
missingLeadFields
object[]
required