List jobs

Jobs are listed from newest to oldest.

$ curl -H "X-Planado-API-Key:XXX" https://api.planadoapp.com/v2/jobs | jq
{
  "jobs": [
    {
      "uuid": "137eafeb-15d1-6480-022b-0ec4617ba21a",
      "external_id": "job",
      "external_order_id": "crm-deal-678190454834217",
      "serial_no": 22469,
      "status": "scheduled",
      "scheduled_at": "2019-11-20T06:25:00",
      "scheduled_duration": {
        "minutes": 60
      },
      "template_uuid": "e6fb6e46-21a7-4d1e-abec-19e5e7dcdb43",
      "client_uuid": "298b4eca-757a-5296-9078-a9991942704f",
      "site_uuid": "eb5140ea-d635-45a3-ad77-6750a995c126",
      "type_uuid": "9898b1d8-a04b-4073-a08e-b470f029fdb2",
      "assignee": {
        "worker_uuid": "4132ed05-3b6d-456c-b3ef-ee1cc6af1e90"
      },
      "skill_uuids": ["a1620b1d-257d-49a9-9adf-6e958603c571"],
      "territory_uuid": "70f19e99-d3e3-4366-8bd9-2f1c8c8c784a",
      "version": 5,
      "created_at": "2016-05-29T17:31:01.419601Z",
      "updated_at": "2016-06-07T10:57:19.529209Z"
    },
    ...
  ]
}
Table 1. Fields of jobs elements
Field Type JSON type Can be null Description

uuid

UUID

String

No

Unique identifier

external_id

String

String

Yes

Unique identifier in an external system.
Use it for linking sites with data from another source

external_order_id

String

String

Yes

Order identifier in an external system.
This value is not unique, you can link multiple jobs to a single order, deal or similar thing in another system

serial_no

Integer

Number

No

Sequential job number

status

String

String

No

Current job status

scheduled_at

Datetime

String

Yes

Planned job start time

scheduled_duration

Duration

String

Yes

Planned job duration

description

String

String

Yes

Large text with job decription. Limited to 15000 characters

assignee

Asssignee

Object

Yes

Either a user or a team

type_uuid

UUID

String

No

Job type identifier

template_uuid

UUID

String

Yes

Template identifier

client_uuid

UUID

String

Yes

Client identifier

site_uuid

UUID

String

Yes

Site identifier

contacts

[Contact]

Array

No

List of job contacts

territory_uuid

UUID

String

Yes

Territory identifier

skill_uuids

[UUID]

Array

No

List of skill identifiers required to complete the job

version

Integer

Number

No

Version

created_at

Timestamp

String

No

Timestamp of creation

updated_at

Timestamp

String

No

Timestamp of last update

Filters

By updated_at value

$ curl -H "X-Planado-API-Key:XXX" "https://api.planadoapp.com/v2/jobs?updated_at[before]=2019-10-01T10:30:10Z&updated_at[after]=2019-09-30T10:30:10Z" | jq
{
  "jobs": [...]
}
before and after filters use strict comparison. Both values are optional.

See also