Viewing jobs

Last updated 8 months ago

get
Individual job view endpoint

https://prod-api.spatula.io
/v2/graph/role/jobs/:id?access_token=AUTH_TOKEN
This request fetches an individual job from the API
Request
Response
Path Parameters
:id
required
string
The job's ID e.g.
Query Parameters
access_token
optional
string
API access token
200: OK
If the job exists and you are permitted to see it, the API will respond with the job object
{
"id": 5788549471,
"name": "A New Job",
"status": "open"
"created": 1531739884663,
"tracking": "https://example.org/not-a-real-tracking-link",
"contact": {
"address": "",
"phone": "+61234567890",
"name": "John Example"
},
"attr": {
"items": [
{
"key": "Extra field"
"value": "Some field value",
}
]
},
"tasks": {
"items": [
{
"zone": {
"address": "Example Cafe",
"name": "Pickup @ Example Cafe",
"id": 5788549470,
"coords": {
"lon": 115.81415500000003,
"lat": -31.977832
}
},
"id": 5788549470
}
]
}
}
404: Not Found
If the job does not exist or you are not permitted to see it, the API will respond with a 404
"The requested resource could not be found"

Example

shell
curl 'https://prod-api.spatula.io/v2/graph/role/jobs/5788549471?access_token=AUTH_TOKEN'

‚Äč