Sign in
latestSwagger 2.02026-08-10143234301.7 KB

dc2736850e42

Rest

Gets all the available sessions for a client at a studio

get/Users/ClientSeries

Query parameters

clientIdstring required

Headers

Authorizationstring required

Bearer {user_token}

SiteIdinteger required

Site ID

Response

OK

IDinteger

ID of the client series.

ProductIdinteger

ProductId of the series.

Namestring

Name of the series.

TotalSessionsinteger

Total sessions the series is initially sold with.

SessionsRemaininginteger

Sessions remaining on the client series.

ActiveDatestring date-time

Activation date of the client series.

ExpirationDatestring date-time

Expiration date of the client series.

IsUnlimitedboolean

Represents whether or not this series has unlimited sessions.

ProgramIdinteger

ProgramId that the series can be used to pay for.

SessionTypeIdsinteger[]

List of session type ids that this series can be used to pay for.

ProgramType'Class' | 'Appointment' | 'Enrollment' | 'Media' | 'Resource' | 'Arrival'

Program type that this series can be used to pay for.