List services

Returns the services offered by the companies linked to the API token and their locations, ordered by name. Filterable by name and type. Requires the service.list scope.

GET /api/v2/services

List services

cURL

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

200

{
  "data": [
    {
      "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"
    }
  ],
  "limit": 10,
  "page": 1,
  "total": 1
}

Authorizations

Authorization · string · header · required

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

Query Parameters

limit · integer · default: 10

Number of items per page (max 20).

Required range: 1 <= x <= 20

Example:

10

page · integer · default: 1

Page of results to return (1-based).

Required range: 1 <= x <= 10000

Example:

1

name · string

Filter by service name (case-insensitive partial match).

Required string length: 1 - 255

Example:

"panel"

type · enum<string>

Filter by service type (exact match).

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

Example:

"labBasedToxicology"

Response

200

application/json

Success.

data · object[] · required

Items on this page.

Show child attributes

limit · integer · required

Number of items per page.

Example:

10

page · integer · required

Current page number (1-based).

Example:

1

total · integer · required

Number of matching items across all pages.

Example:

1