Skip to main content

ListClasses

GET /tp-api/classes

Find in-person or virtual instructor-led classes.

Query Parameters
  • cursor string

    Cursor to return items after a specific position in the list.

  • limit integer

    Possible values: >= 1 and <= 100

    Default value: 10

    Maximum number of items to return.

  • skip integer

    Query to retrieve the items starting from that position in the dataset.

  • ids string[]

    Filter classes by an array of class ids.

  • courseDeliveryMethod any

    Filter classes by course delivery method. OFFLINE or VIRTUAL.

  • courseIds string[]

    Filter classes by course ids.

  • start date-time

    Filter classes who's start date is after the given date-time

  • end date-time

    Filter classes who's end date is before the given date-time

Header Parameters
  • training-provider-id string required
Responses

Default Response

Schema
  • Array [
  • id string required

    Class id

  • address object

    Class Location. This is required for in-person classes

  • countryCode string

    Possible values: >= 2 characters and <= 2 characters

    2 letter country code

  • district string

    District name

  • extendedAddress string

    Address line 2

  • locality string

    City

  • name string

    Location name or Site name

  • postalCode string

    Postal code

  • postOfficeBox string

    Post office box

  • region string

    Province/State

  • streetAddress string

    Address line 1

  • contact object required
  • email email required

    Main contact email address

  • fax object required
  • anyOf
  • string

    Main contact fax number

  • telephone object required
  • anyOf
  • string

    Main contact phone number

  • course object required
  • id string required

    Course id

  • name string required

    Course name

  • created date-time required

    Class creation time

  • deliveryMethod object required

    Course delivery method

  • anyOf
  • string

    Possible values: [OFFLINE]

  • evaluators object[] required

    List of class evaluators

  • Array [
  • id string required

    Evaluator user id

  • firstname string required

    Evaluator firstname

  • lastname string required

    Evaluator lastname

  • ]
  • externalRegistrationUrl string required

    Class external registration URL

  • instructors object[] required

    List of class instructors

  • Array [
  • id string required

    Instructor user id

  • firstname string required

    Instructor firstname

  • lastname string required

    Instructor lastname

  • ]
  • price number required

    Class price

  • publishInMarketplace boolean required

    Should the class appear in the marketplace

  • schedule object[] required
  • Array [
  • id string required

    Event id

  • start date-time required

    Class start time

  • end date-time required

    Class end time

  • ]
  • seatsInventory object required
  • totalSeats number required

    Total class seats

  • booked number required

    Booked class seats

  • remaining number required

    Remaining class seats

  • showPriceInMarketplace boolean required

    Should this class's price appear in the marketplace

  • specialInstructions object required
  • anyOf
  • string

    Class special instructions

  • timezone string required

    Class timezone in the form area/location

  • virtualClassUrl uri

    Virtual class url. This field is required for virtual classes

  • ]
    • Loading...