/access

/access

GET /access/locations

Gets the list of locations that your account can access.

GET https://api.club-os.com/access/locations

Success Response

If successful, you will be returned a Location objects containing the following:

Property

Type

Description

id

Integer

The Club OS unique id for the location.

name

String

The name of the location.

systemId

String

The member management / billing system ID for the location.

Failure Response

If your request fails, you will receive a Response object containing the following:

Property

Type

Description

status

Boolean

Will always be false.

responses

ResponseMessage[]

An array of ResponseMessage objects describing the error.

GET /access/services

Gets the list of service endpoints that your account can access.

GET https://api.club-os.com/access/services

Success Response

If successful, you will be returned a Strings containing the following:

Property

Type

Description

Endpoint Name

String

The URL of the endpoint.

Failure Response

If your request fails, you will receive a Response object containing the following:

Property

Type

Description

status

Boolean

Will always be false.

responses

ResponseMessage[]

An array of ResponseMessage objects describing the error.