Get a chain client by phone number.

Request

Parameter
- group_id (required, number, 43877) - ID of the location chain

Client filtering

phone:'+13155550175' (optional, string) - Phone to filter clients

Security

BearerPartnerUser

Path

chain_idnumberrequired

Chain ID

Query

phonestringrequired

Phone to filter clients, required parameter

Example:phone=14264037640

Acceptstringrequired

e.g. application/vnd.api.v2+json

Example:application/vnd.api.v2+json

Content-Typestringrequired

application/json

Authorizationstringrequired

Bearer partner_token.User user_token

curl -i -X GET \
  'https://developer.alteg.io/_mock/en/b2b-v1/openapi/chains/{chain_id}/clients?phone=14264037640' \
  -H 'Accept: application/vnd.api.v2+json' \
  -H 'Authorization: Bearer <YOUR_Bearer {PartnerToken}, User {UserToken}_HERE>' \
  -H 'Content-Type: string'

Responses

OK

Bodyapplication/json

successboolean

Execution success status (true)

Example:true

dataobject

Object with data

Example:

{
  "salon_group_id": 312,
  "phone": "+13155550175",
  "clients": [
    { … },
    { … }
  ]
}

metaArray of objects

Metadata (empty array)

Example:

[]

Response

{
  "success": true,
  "data": {
    "salon_group_id": 312,
    "phone": "+13155550175",
    "clients": [ … ]
  },
  "meta": []
}