Service Tasks

Retrieve Service Task

Retrieve the details of an existing Service Task.

get/service_tasks/{id}

Request

Path parameters

idstring required

The id of the relevant record

Query parameters

service_task_partsstring

Currently accepts service_task_parts.

Response

OK

idinteger required
created_atstring date-time

The date and time at which this record was created.

updated_atstring date-time

The date and time at which this record was most recently updated.

namestring required

A name for this Service Task.

descriptionstring nullable required

A description of this Service Task.

expected_duration_in_secondsinteger nullable

The expected duration in seconds this Service Task should take to complete.

archived_atstring date-time nullable

The date and time at which this Service Task was archived. null if this Service Task is active.

usageinteger

Indicates the number of times this Service Task has been used. Available by setting the include_usage query parameter to 1.

Example response

{
  "created_at": "2023-03-14T13:46:27-06:00",
  "updated_at": "2023-03-14T13:46:27-06:00",
  "subtasks": [
    {
      "created_at": "2023-03-14T13:46:27-06:00",
      "updated_at": "2023-03-14T13:46:27-06:00"
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.