Job Activities

List all Job Activities

Changed on

Filtering

This endpoint supports result filtering. For more information on how to filter this request, go here.

OAuth Scope

This endpoint requires the following OAuth scope read_schedule.

get/jobactivity.json

Request

  • Base URL
    https://api.servicem8.com/api_1.0
  • URL
    https://api.servicem8.com/api_1.0/jobactivity.json
  • Auth
    • API key in header X-Api-Key
    • or OAuth 2
      Authorization code: https://api.servicem8.com/oauth/authorize
      Token URL: https://api.servicem8.com/oauth/access_token scopes: read_schedule

Response

An array of Job Activities

job_uuidstring uuid

The UUID of the job this activity belongs to

staff_uuidstring uuid

The UUID of the staff member assigned to this activity

start_datestring

The scheduled start date and time of the activity

end_datestring

The scheduled end date and time of the activity

activity_was_scheduledstring

Boolean flag indicating whether this activity was scheduled in advance. Cannot be true if activity_was_recorded is true.

activity_was_recordedstring

Boolean flag indicating whether this activity was recorded after completion rather than scheduled in advance. Cannot be true if activity_was_scheduled is true.

activity_was_automatedstring

Integer flag indicating if the activity was automated: 0

has_been_openedstring

Boolean flag indicating whether the assigned staff member has viewed this job activity. Resets to false if the staff member or start time is changed. Only relevant when activity_was_scheduled is true.

has_been_opened_timestampstring

The date and time when the assigned staff member first viewed this job activity. Format is YYYY-MM-DD HH:MM:SS. Resets when staff member or start time is changed. Only relevant when activity_was_scheduled is true.

travel_time_in_secondsinteger

The estimated travel time to reach this activity location in seconds

travel_distance_in_metersinteger

The estimated travel distance to reach this activity location in meters

allocated_by_staff_uuidunknown
allocated_timestampunknown
material_uuidstring uuid

The UUID of the material associated with this activity. Used to determine the cost of the activity.

uuidstring uuid

Unique identifier for this record

active0 | 1

Record active/deleted flag. Valid values are [0,1]. Valid values are [0,1]

edit_datestring

Timestamp at which record was last modified

edit_by_staff_uuidstring uuid

UUID of Staff Member who last modified record

Example response

[
  {
    "job_uuid": "123e4567-6936-44d0-83ba-23f9472be1fb",
    "staff_uuid": "123e4567-a0f7-474a-82bd-23f94f782d2b",
    "start_date": "2026-03-01 12:00:00",
    "end_date": "2026-03-01 12:00:00",
    "has_been_opened_timestamp": "2026-03-01 12:00:00",
    "material_uuid": "123e4567-7e05-487e-8d4f-23f949cabc8b",
    "uuid": "123e4567-6368-44da-9b33-23f94fc2f5bb",
    "edit_date": "2026-03-01 12:00:00",
    "edit_by_staff_uuid": "123e4567-d7fe-421d-8379-23f9423667ab"
  }
]

Changes

  • 638a8df09bf4Revision changes
    • breaking

      the / response's property type changed from string to no type, and format from uuid to no format for status

    • breaking

      the / response's property type changed from string to no type for status

  • ca9b053c4373Revision changes
    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status