Get a package

Returns an active package assigned to a company linked to the API token or to one of its locations. Returns 404 for any failure — does not reveal whether the package exists. Requires the package.read scope.

GET /api/v2/packages/{id}

Get a package

cURL

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

200

{
  "id": "789",
  "name": "DOT Pre-Employment Drug Test",
  "object": "package",
  "locationIds": [
    "456"
  ],
  "services": [
    {
      "id": "a0eebc99-9c0b-4ef8-bb6d-6bb9bd380a11",
      "name": "5 Panel Urine Drug Screen",
      "object": "service",
      "type": "labBasedToxicology",
      "url": "/api/v2/services/a0eebc99-9c0b-4ef8-bb6d-6bb9bd380a11"
    }
  ],
  "url": "/api/v2/packages/789"
}

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:

"123"

Response

200

application/json

Success.

id · string · required

Unique identifier of the package.

Example:

"789"

name · string · required

Package name.

Example:

"DOT Pre-Employment Drug Test"

object · enum<string> · required

Object type; always package.

Available options: package

Example:

"package"

locationIds · string[] · required

Locations that offer the package, under companies linked to the API token: those it is assigned to, and those that inherit it from their company.

Example:

["456"]

services · object[] · required

Services the package includes, ordered by name.

Show child attributes

url · string<uri-reference> · required

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

Example:

"/api/v2/packages/789"