Returns all lab series, lab profiles, and delivery regions available to your organization

Get
/catalog

The Catalog command will return all lab series, lab profiles, and delivery regions available to your organization. Lab profiles are generally grouped into series. Depending on your organization, you may have multiple physical delivery regions available to you.

Security
API Key
Header parameter nameapi_key

All methods require an API key, which must be obtained from Skillable. This key is used by Skillable to validate your account. The key can be passed as an HTTP request header with the header name "api_key".

Query parameters
includeAll
integer (int32)

This parameter can usually be ignored. When not included (or passed as any value except 1), labs that are not currently available for launch will not be included in catalog results. If you want to include all lab profiles, regardless of whether they are enabled or are developmentally complete, you can pass includeAll=1.

Example1
LabSeriesID
integer (int32)

By providing a LabSeriesID, the response will be filtered so that only lab profiles within the specified lab series will be returned.

Example123456
OrganizationID
integer (int32)

By providing an OrganizationID, the response will be filtered so that only lab profiles belonging to the specified organization will be returned. Typically omitted.

Example3
tag
array of string

By providing a Tag, the response will be filtered so that only lab profiles within the specified lab series defined with the identified tag will be returned. Multiple Tag parameters can be defined.

Example[ "mytag1", "mytag2" ]
LabSeriesCreatedAfter
integer (int64)

The date/time (in Unix epoch time) that the Lab Series was created after.

Example1598465099
LabSeriesCreatedBefore
integer (int64)

The date/time (in Unix epoch time) that the Lab Series was created before.

Example1598465099
LabSeriesModifiedAfter
integer (int64)

The date/time (in Unix epoch time) that the Lab Series was modified after.

Example1598465099
LabSeriesModifiedBefore
integer (int64)

The date/time (in Unix epoch time) that the Lab Series was modified before.

Example1598465099
LabProfileCreatedAfter
integer (int64)

The date/time (in Unix epoch time) that the Lab Profile was created after.

Example1598465099
LabProfileCreatedBefore
integer (int64)

The date/time (in Unix epoch time) that the Lab Profile was created before.

Example1598465099
LabProfileModifiedAfter
integer (int64)

The date/time (in Unix epoch time) that the Lab Profile was modified after.

Example1598465099
LabProfileModifiedBefore
integer (int64)

The date/time (in Unix epoch time) that the Lab Profile was modified before.

Example1598465099
Responses
200

OK Response

Collapse all
object
LabSeries
Array of object

Array of Lab Series.

Min items1
object
Id
integer

The unique identifier of the lab series.

Name
string

The name of the lab series.

Min length1
Description
string

A brief description of the lab series.

Min length1
NumTrainingDays
integer

The number of training days expected to complete the series.

AllowAssignments
boolean

Indicates that the Lab Series can be assigned.

AllowAssignmentsUntil
string | null

The date (in Unix epoch time) after which assignments are no longer valid. A null value indicates that assignments do not expire.

Created
integer (int64)

The date (in Unix epoch time) that the Lab Series was created.

LastModified
integer (int64) | null

The date (in Unix epoch time) that the Lab Series was modified.

Price
number (float)

The price of the Lab Series.

LabProfiles
Array of object

Array of Lab Profile.

Min items1
object
DeliveryRegions
Array of object

Array of DeliveryRegion.

Min items1
object
Status
number

Indicates the status of the API request.
0 = Error
1 = Success

Error
string | null

In the event of an error, this will contain a detailed error message.