Staff Messages

Retrieve a Staff Message

Changed on

OAuth Scope

This endpoint requires the following OAuth scope read_messages.

get/staffmessage/{uuid}.json

Request

  • Base URL
    https://api.servicem8.com/api_1.0
  • URL
    https://api.servicem8.com/api_1.0/staffmessage/{uuid}.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_messages

Path parameters

uuidstring uuid required

UUID of the Staff Message

Response

Staff Message record retrieved successfully

from_staff_uuidstring uuid

Unique identifier (UUID) of the staff member who sent this message. Identifies the sender of the communication within the system.

to_staff_uuidstring uuid

Unique identifier (UUID) of the staff member who received this message. Identifies the intended recipient of the communication.

sent_timestampstring

The date and time when the message was sent. Format is YYYY-MM-DD HH:MM:SS. This field is automatically set to the current time when a new message is created.

delivered_timestampstring

The date and time when the message was delivered to the recipient's device. Format is YYYY-MM-DD HH:MM:SS. This field may be null if delivery confirmation is not available.

read_timestampstring

The date and time when the message was read by the recipient. Format is YYYY-MM-DD HH:MM:SS. This field may be null if the message has not been read or if read receipts are not available.

messagestring

The text content of the message. Supports Unicode characters for international language support. This field contains the actual message being sent between staff members.

regarding_job_uuidstring uuid

Unique identifier (UUID) of the job this message is related to. Optional field that links the message to a specific job for context. This field may be null if the message is not related to a specific job.

uuidstring uuid

Unique identifier for this record

active0 | 1

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

edit_datestring

Timestamp at which record was last modified

attached_jsonstring

Example response

{
  "from_staff_uuid": "123e4567-ea0f-4b85-a876-23f943f26c6b",
  "to_staff_uuid": "123e4567-2507-4025-837a-23f94a6d8e5b",
  "sent_timestamp": "2026-03-01 12:00:00",
  "delivered_timestamp": "2026-03-01 12:00:00",
  "read_timestamp": "2026-03-01 12:00:00",
  "regarding_job_uuid": "123e4567-eaa4-4b56-b032-23f94789c1fb",
  "uuid": "123e4567-58f2-4245-9114-23f9431fd34b",
  "edit_date": "2026-03-01 12:00:00"
}

Changes

  • 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

    • info

      added the non-success response with the status

  • e859f8c27a21Revision changes
    • info

      the security scope read_messages was added to the endpoint's security scheme oauth2