Retrieve the partners list

get/v0/partners

Request

Base URL: https://api.clubmed.com
URL: https://api.clubmed.com/v0/partners
Auth: HTTP bearer

Query parameters

country_codestring[] required

Possible values: FR, BE, CH, NL, DE, IL, IT, SE, PT, ZA, ES, GB, CY, TR, RU, UA, DK, FI, NO, IE, US, MX, CA, PA, AR, CL, BR, CO, PE, VE, UY, CN, TW, HK, AU, ID, IN, JP, KR, MY, NZ, SG, TH, VN, AT, RO, PL, EE, LV, LB, MA, AF, AL, DZ, AD, AO, AG, SA, AM, BS, BH, BD, BB, BZ, BJ, BM, BT, MM, BO, BW, BN, BG, BI, BF, CM, CV, KY, CF, SH, KM, CG, KP, CR, CI, CU, DJ, DO, DM, EG, SV, AE, EC, ET, FJ, GA, GM, GH, GI, GR, GD, GT, GN, GW, GQ, GY, GP, GF, HT, HN, HU, IQ, IR, IS, TL, JM, JO, KZ, KH, KE, KI, KW, LA, LS, LR, LY, LI, LU, MO, MG, MW, MV, ML, MT, MU, MR, YT, MC, MN, MQ, MZ, MD, PS, NA, NR, NP, NI, NE, NG, NC, CK, OM, UG, PK, PG, PY, PH, PN, PF, PR, QA, RW, RE, BL, KN, MF, LC, SM, PM, VC, SB, WS, ST, SN, SC, SL, SO, SD, LK, SR, SZ, SY, TZ, TD, CZ, IO, TF, TG, TO, TT, TN, TC, TV, VU, VA, VG, WF, YE, RS, CD, ZM, ZW, ME, FM, MH, PW, HR, SI, SK, LT, MK, BA, UZ, BY, TJ, GE, AZ, TM

filterFilterParamModel[]

string composed of a field name (can be a path), a comparison operator (>, >=, <=, <, ==, !=) and a value. Logical operator AND applies between filters

Headers

x-api-keystring required

Api_key provided by ClubMed API team

Response

idstring required

partner ID. Ex: "OPERA" stands for Opera agency.

namestring required

Partners name

labelstring

Partner's alternative name

display_on_websiteboolean required

Partner can be displayed as near the customer

emailstring

Partners email

typestring

Partners type (CLUBMED, FRANCHISE, COLLECTIVITY, INDIRECT)

Example response

[
  {
    "id": "OPERA",
    "name": "CLUB MED VOYAGES PARIS 1ER",
    "label": "Agence Club Med Paris Centre",
    "display_on_website": true,
    "email": "agence.opera@clubmed.com",
    "type": "CLUBMED",
    "address": {
      "number": "15",
      "street": "AVENUE DES CHAMPS ELYSEES",
      "add_on": "6A",
      "town": "Luynes",
      "city": "Aix-en-Provence",
      "zip_code": "75000",
      "state_or_district": "CA",
      "country": "FRANCE",
      "country_code": "FR",
      "additional_information_1": "Chez M. Dupont",
      "additional_information_2": "Entreprise Clubmed"
    },
    "geo_data": {
      "latitude": 45.788163,
      "longitude": 4.77612
    },
    "opening_days": [
      {
        "day": "lundi",
        "business_hours": [
          {
            "opening": "09:30:00",
            "closing": "12:00:00"
          },
          {
            "opening": "14:00:00",
            "closing": "18:00:00"
          }
        ]
      },
      {
        "day": "mardi",
        "business_hours": null
      }
    ],
    "phones": [
      {
        "number": "0623456789",
        "type": "MOBILE"
      }
    ],
    "_links": [
      {
        "rel": "self",
        "deprecated_rel": true,
        "method": "GET",
        "href": "https://api.clubmed.com/products",
        "label": "A label"
      }
    ]
  }
]

Changes

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