Retrieve an existing Program

Request

Returns an existing Program with the input ID.

Security

basic_auth

Path

idstringrequired

ID of the Program to retrieve.

curl -i -X GET \
  -u '<username>:<password>' \
  'https://docs.checkr.com/_mock/apis/openapi/programs/{id}'

Responses

Program details

Bodyapplication/json

idstring(ResourceId)read-only

ID of the resource.

Example:"e44aa283528e6fde7d542194"

objectstringread-only

Value:"program"

namestring

Human-readable name of the Program.

Example:"Program A"

created_atstring, (date-time)

Time at which the resource was created.

Example:"2017-08-07T16:51:09Z"

deleted_atstring or null, (date-time)

Time at which the resource was deleted.

Example:null

package_idsArray of strings

Array of associated Package IDs.

Example:

[
  "a57a0cd15965a585ff7d5d35"
]

geo_idsArray of strings

Array of associated Geo IDs.

Example:

[
  "cbc37748bc6a45b41af5c3f5"
]

Response

{
  "id": "e44aa283528e6fde7d542194",
  "object": "program",
  "name": "Program A",
  "created_at": "2017-08-07T16:51:09Z",
  "deleted_at": null,
  "package_ids": [
    "a57a0cd15965a585ff7d5d35"
  ],
  "geo_ids": [
    "cbc37748bc6a45b41af5c3f5"
  ]
}