Get a service

Returns a service offered by a company linked to the API token or by one of its locations. Returns 404 for any failure — does not reveal whether the service exists. Requires the service.read scope.

GET /api/v2/services/{id}

Get a service

cURL

curl --request GET \
  --url https://api.stage.origin.one/api/v2/services/{id} \
  --header 'Authorization: Bearer <token>'

200

{
  "id": "a0eebc99-9c0b-4ef8-bb6d-6bb9bd380a11",
  "name": "5 Panel Urine Drug Screen",
  "object": "service",
  "type": "labBasedToxicology",
  "attributes": {
    "category": "standardPanels",
    "type": "urine"
  },
  "isDot": false,
  "url": "/api/v2/services/a0eebc99-9c0b-4ef8-bb6d-6bb9bd380a11"
}

Authorizations

Authorization · string · header · required

Origin One API token. Pass it in the Authorization header: Authorization: Bearer <token>.

Path Parameters

id · string · required

Unique identifier of the resource.

Example:

"a0eebc99-9c0b-4ef8-bb6d-6bb9bd380a11"

Response

200

application/json

Success.

id · string · required

Unique identifier of the service.

Example:

"a0eebc99-9c0b-4ef8-bb6d-6bb9bd380a11"

name · string · required

Service name.

Example:

"5 Panel Urine Drug Screen"

object · enum<string> · required

Object type; always service.

Available options: service

Example:

"service"

type · enum<string> string · required

Service type. New values may be added.

Available options: additionalService, backgroundCheckService, breathAlcoholTest, clinical, confirmationTest, injuryCareService, instantDrugTest, labBasedToxicology, occupationalHealthService, safetyTraining, vaccination, mroService, unknown

Example:

"labBasedToxicology"

attributes · object | null · required

Testing category and specimen type; null when the service has neither.

Show child attributes

isDot · boolean · required

Whether the service is a DOT-regulated test.

Example:

false

url · string<uri-reference> · required

Canonical path of this resource, relative to the API origin.

Example:

"/api/v2/services/a0eebc99-9c0b-4ef8-bb6d-6bb9bd380a11"