admin

Returns the list of API keys with their info

Returns the list of API keys with their info. Accessible by GO only.

get/v0/api_keys

Request

  • Base URL: https://api.clubmed.com
  • URL: https://api.clubmed.com/v0/api_keys
  • Auth: OpenID Connect (https://auth.clubmed.com/.well-known/openid-configuration, scopes: openid, email, profile, clubmed)

Headers

authorizationstring required

Optional Access Token (bearer)

Example:Bearer aaaa.vbbbB.bbbb

Access Token (bearer)

x-api-keystring required

Api_key provided by ClubMed API team

Response

ok

idstring

Api_key provided by ClubMed API team

profilestring required

api_key profile

contactsstring[] required

api_key contact emails

localesstring[] required

List of allowed locales for this client

clic_channel_codestring required

CLIC channel code

channel_codestring required

Channel code

application_codestring required

Application code

date_offset_enabledboolean

Is the date offset should be considered for the api_key

enabledboolean required

Is the api_key enabled

authentication_requiredboolean

Is authentication required

agent_idstring

Agent id

consumerstring

Consumer of the API key, e.g. "B2C", "APP", "CMTA", "B2B"

prebookable_price_accessboolean

If true, this API key will have access to prebookable prices across all API endpoints (no impact on the calendar and bookable_dates endpoints).

quable_channel_codestring nullable

Quable channel code associated with the API key

Example response

[
  {
    "id": "878545411597.test.clubmed.com",
    "profile": "b2c",
    "contacts": [
      "john.smith@gmail.com"
    ],
    "locales": [
      "en-US"
    ],
    "clic_channel_code": "TDB",
    "channel_code": "NET",
    "quable_channel_code": "B2B"
  }
]

Changes

No recorded changes to this operation across all 1 revision of this API.