Avoca — Internal

Appearance

--- aside: false outline: false ---

Get many jobs​

GET
/clients/{clientId}/jobs

Authorizations​

bearerAuth
Type
HTTP (bearer)

Parameters​

Path Parameters

clientId*
Type
string
Required
Pattern
"^cl_"

Query Parameters

id

Can be a comma-separated list

Type
string
Pattern
"^job_"
customer

Filter to jobs for one or more customers. Can be a comma-separated list.

Type
string
expand

Available values: customer, vehicle, bookingSession, service. Can be a comma-separated list

Type
string
updatedAfter
Type
string
updatedAt.gte
Type
[ "string", "null" ]
updatedAt.lt
Type
[ "string", "null" ]
pageIndex
Type
[ "integer", "null" ]
Minimum
0
Default
0
pageSize
Type
[ "integer", "null" ]
Minimum
0
Maximum
100
Default
25

Responses​

Paged job objects

application/json
JSON
{
  
"data": [
  
  
{
  
  
  
"id": "string",
  
  
  
"createdAt": "string",
  
  
  
"updatedAt": "string",
  
  
  
"steerTenantId": "string",
  
  
  
"steerShopId": "string",
  
  
  
"bookingSession": "string",
  
  
  
"client": "string",
  
  
  
"customer": "string",
  
  
  
"vehicle": "string",
  
  
  
"extId": "string",
  
  
  
"isDroppingOff": true,
  
  
  
"appointmentType": "string",
  
  
  
"isNewCustomer": true,
  
  
  
"isAfterHours": true,
  
  
  
"scheduledStartAt": "string",
  
  
  
"scheduledEndAt": "string",
  
  
  
"scheduledLabel": "string",
  
  
  
"currentStartAt": "string",
  
  
  
"currentEndAt": "string",
  
  
  
"services": [
  
  
  
  
{
  
  
  
  
  
"id": "string",
  
  
  
  
  
"service": "string",
  
  
  
  
  
"issueDescription": [
  
  
  
  
  
  
"string"
  
  
  
  
  
],
  
  
  
  
  
"customerNotes": "string",
  
  
  
  
  
"estimatedValue": 0
  
  
  
  
}
  
  
  
],
  
  
  
"marketingSource": "string",
  
  
  
"aoIssueTreeKey": "string",
  
  
  
"aoThemeKey": "string",
  
  
  
"aoIPAddress": "string",
  
  
  
"aoLanguage": "string"
  
  
}
  
],
  
"pageIndex": 0,
  
"pageSize": 0,
  
"totalCount": 0
}

Playground​

Authorization
Variables
Key
Value

Samples​

Powered by VitePress OpenAPI