customers

Retrieve a list of customers. Available filters are: gm_number, first_name, last_name, phones.number, birthdate, email, address.zip_code, loyalty_program.status, offers.code.

get/v1/customers

Request

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

Query parameters

filterFilterParamModel[]

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

string composed of a field name (can be a path), a comparison operator (>, >=, <=, <, ==, !=) and a value. Logical operator AND applies between filters. Valid filters are : gm_number, first_name, last_name, phones.number, birthdate, email, address.zip_code, loyalty_program.status.

offer_codestring

specific offer code

view'SELLER' | 'AGENCY' | 'NETWORK'

Requested view for Partners only. SELLER means you want your seller customers. AGENCY means you want your agency customers. NETWORK means you want your network customers. Possible values: SELLER, AGENCY, NETWORK. This parameter is optional.

Example:AGENCY
limitinteger

Maximum rows count per page

pageinteger

Requested page number, starting from 1 (default: 1)

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 required

Customer ID (neolid clic)

blacklistedboolean nullable

Indicates if a client is blacklisted or not

gm_numberstring nullable

great member number

civilitystring nullable

civility of the customer

first_namestring

first name of the customer

unicode_first_namestring

first name in unicode of the customer

last_namestring

last name of the customer

unicode_last_namestring

last name in unicode of the customer

birthdatestring nullable

birthdate of the customer

emailstring

email of the customer

type'CLIENT' | 'PROSPECT' | 'GO' | 'AGENT' | 'AGENCE'

type of the customer

birth_country_codestring

Customer's birth's country's code

health_pass_idstring

Health pass id

Example response

[
  {
    "id": "123456789",
    "gm_number": "123456789",
    "civility": "MR",
    "first_name": "John",
    "last_name": "Smith",
    "birthdate": "19800117",
    "email": "john@h.fr",
    "type": "CLIENT",
    "birth_country_code": "FR",
    "phones": [
      {
        "number": "0623456789",
        "type": "MOBILE"
      }
    ],
    "health_pass_id": "1234567892",
    "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"
    },
    "passport": {
      "birthdate": "20100430",
      "document_number": "09PR5121E",
      "authority": "prefecture de paris",
      "birthplace": "Paris",
      "nationality": "FR",
      "issuing_date": "20100430",
      "expiration_date": "20100430",
      "serial_number": "123456789",
      "birth_country": "FR",
      "birth_city": "Versailles",
      "residence_city": "Paris",
      "issuing_country": "FR"
    },
    "id_card": {
      "birthdate": "20100430",
      "document_number": "09PR5121E",
      "authority": "prefecture de paris",
      "birthplace": "Paris",
      "nationality": "FR",
      "issuing_date": "20100430",
      "expiration_date": "20100430",
      "birth_country": "FR",
      "residence_city": "Paris",
      "birth_city": "Versailles",
      "issuing_country": "FR"
    },
    "driving_licence": {
      "birthdate": "20100430",
      "document_number": "09PR5121E",
      "authority": "prefecture de paris",
      "issuing_country": "FR",
      "birthplace": "Paris",
      "issuing_date": "20100430",
      "expiration_date": "20100430"
    },
    "_links": [
      {
        "rel": "self",
        "deprecated_rel": true,
        "method": "GET",
        "href": "https://api.clubmed.com/products",
        "label": "A label"
      }
    ],
    "identity": {
      "number": "E001241",
      "type": "TAX_NUMBER"
    },
    "loyalty_program": {
      "status": "EXCLUDED",
      "points": 1200
    }
  }
]

Changes

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