Badges

Retrieve a Badge

Changed on

OAuth Scope

This endpoint requires the following OAuth scope manage_badges.

get/badge/{uuid}.json

Request

  • Base URL
    https://api.servicem8.com/api_1.0
  • URL
    https://api.servicem8.com/api_1.0/badge/{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: manage_badges

Path parameters

uuidstring uuid required

UUID of the Badge

Response

Badge record retrieved successfully

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

namestring required

The display name of the badge. Used to identify the badge in the system. Examples include 'Warranty', 'VIP', 'Take Payment Facilities', etc.

automatically_allocatedstring
file_namestring
regarding_form_uuidstring uuid
regarding_asset_type_uuidstring uuid

UUID of the asset type that this badge is associated with. Only applicable for asset-based badges. When set, the badge represents a specific asset type in the system and will appear on assets of this type.

Example response

{
  "uuid": "123e4567-9259-4a43-8a62-23f947f6e74b",
  "edit_date": "2026-03-01 12:00:00",
  "regarding_form_uuid": "123e4567-31b4-475f-8328-23f94ee2d83b",
  "regarding_asset_type_uuid": "123e4567-f401-47d3-8ab9-23f94645b98b"
}

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