Deprecated. Get full client profiles in a location

Deprecated. Get full client profiles in a location
deprecated

Request

Returns full client cards (including categories, custom fields, lifetime spent and paid amounts) in ascending client ID order. The default page is 1 and the default count is 20; count is limited to 300. The response includes meta.total_count for pagination. Requires both location edit access and client-base access. Phone, email and comments can be masked or omitted according to the user permissions. This legacy route has only the filters listed below. For richer segmentation and sorting, use POST /company/{location_id}/clients/search; that endpoint returns a selected field projection rather than full cards.

Security

BearerPartnerUser

Path

location_idnumberrequired

location ID

Query

fullnamestring

Name (part of the name) for client filtering

Example:fullname=Joh

phonestring

Phone (part of the number) for customer filtering

Example:phone=1315

cardstring

Loyalty card number fragment

id[]Array of integers

Repeat this parameter for each client ID to include

emailstring

Email (part) for customer filtering

Example:email=test@

paid_mininteger, >= 1

Minimum amount paid, to filter customers by the amount of payments

Example:paid_min=1

paid_maxinteger, >= 1

Maximum amount paid, to filter customers by the amount of payments

Example:paid_max=1

pageinteger, >= 1

Page number

Default:1

Example:page=1

countinteger, [ 1 .. 300 ]

Number of customers per page

Default:20

Example:count=20

idinteger

Client ID (for several IDs, use the repeated id[] parameter)

Example:id=66

changed_afterstring, (date-time)

Include clients changed after this ISO 8601 date-time

changed_beforestring, (date-time)

Include clients changed before this ISO 8601 date-time

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/clients/{location_id}?fullname=Joh&phone=1315&card=string&id%5B%5D=0&email=test%40&paid_min=1&paid_max=1&page=1&count=20&id=66&changed_after=2019-08-24T14%3A15%3A22Z&changed_before=2019-08-24T14%3A15%3A22Z' \
  -H 'Accept: application/vnd.api.v2+json' \
  -H 'Authorization: Bearer <YOUR_Bearer {PartnerToken}, User {UserToken}_HERE>' \
  -H 'Content-Type: string'

Responses

Bodyapplication/json

successboolean

Execution success status (true)

Example:true

dataArray of objects

Array of objects with data

Example:

[
  {
    "id": 66,
    "name": "James",
    "surname": "Smith",
    "patronymic": "A",
    "display_name": "James Smith",
    "phone": "+13155550177",
    "email": "james@example.com",
    "categories": [ … ],
    "sex_id": 1,
    "sex": "Male",
    "discount": 10,
    "importance_id": 3,
    "importance": "Gold",
    "card": "000123",
    "birth_date": "1990-04-03",
    "comment": "Prefers mornings",
    "sms_check": 1,
    "sms_not": 0,
    "spent": 1250.5,
    "paid": 1200,
    "balance": -50.5,
    "visits": 9,
    "last_change_date": "2026-02-01T12:00:00-0500",
    "custom_fields": {}
  }
]

metaobject

Pagination metadata (current page and total matching clients)

Example:

{
  "page": 1,
  "total_count": 1
}

Response

{
  "success": true,
  "data": [
    { … },
    { … }
  ],
  "meta": {
    "page": 1,
    "total_count": 8
  }
}