Skip to content
BILLZ for developers

Detailed information on a single customer

GET
/v1/customer/{id}
curl --request GET \
  --url https://api-admin.billz.ai/v1/customer/622c8993-9f82-45ae-a69d-63103d8506d5 \
  --header 'Authorization: Bearer <token>' \
  --header 'platform-id: 7d4a4c38-dd84-4902-b744-0488b80a4c01'

Error codes: 400 — input validation error; 404 — object not found; 401, 403, 429, 500 — shared by all methods. Body formats and semantics: Response codes and errors.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
id
required
string format: uuid

Customer identifier; must be a valid UUID

Example
622c8993-9f82-45ae-a69d-63103d8506d5

Header Parameters

Section titled “Header Parameters”
platform-id
string
default: 7d4a4c38-dd84-4902-b744-0488b80a4c01

Platform identifier. A static value is used for integrations.

Responses

Section titled “Responses”

200

Section titled “200”

Successful response

Media typeapplication/json
object
id

Customer ID

string format: uuid
external_id

External identifier

string
company_id

Company ID

string
first_name

Name

string
last_name

Last name

string
middle_name

Patronymic

string
language

Enums: ru,en,uz

string
date_of_birth

Date of birth

string
gender

Example: male, female (lowercase)

string
phone_numbers

Phones

Array<string>
marital_status

Example: single, married

string
registered_shop

Registration shop

object
id
string
name
string
registered_shop_name
string
last_purchase_date

Last purchase date

string
channel

Channel

object
id
string
company_id
string
name
string
session_id
string
sms_notification

SMS notifications

boolean
phone_notification

Phone notifications

boolean
social_network_notification

Social network notifications

boolean
purchase_amount

Purchases amount

number format: double
debt_amount

Debt amount

number format: double
email_notification

Email notifications

boolean
groups

Groups and tags; fields: id, company_id, name, session_id, loyalty_level_id, group_type, active, is_auto, description, external_id, created_at, discount_percent, customer_group_id, segment_conditions, customer_qty, works_on_retail_price, works_on_free_price, works_on_wholesale_price

Array<object>
object
id
string
company_id
string
name
string
session_id
string
loyalty_level_id
string
group_type
string
active
boolean
is_auto
boolean
description
string
external_id
string
created_at
string
discount_percent
integer
customer_group_id
string
segment_conditions
Array<object>
nullable
object
customer_qty
integer
works_on_retail_price
boolean
works_on_free_price
boolean
works_on_wholesale_price
boolean
group_names
Array<string>
nullable
tag_names
Array<string>
nullable
cards

Customer cards

Array<object>
object
id
string
name
string
code
string
is_active
boolean
created_at

Creation date

string
loyalty_program_id

Loyalty program ID

string
loyalty_program_level_id

Loyalty program level ID

string
last_update_date

Last update date

string
balance

Cashback balance

number format: double
company_name

Company name

string
chat_id

Telegram chat_id

string
first_purchase_date

First purchase date

string
source_id

Source identifier

string
deleted_at

0 — not deleted; with any other value the method responds with 404

integer format: int64
country_name
string
addresses

Addresses

Array<object>
object
id
string
country_id
string
city
string
address
string
postcode
string
note
string
social_networks

Social networks (duplicate declaration)

Array<object>
object
id
string
name
string
value
string
relatives

Relatives

Array<object>
object
id
string
first_name
string
last_name
string
middle_name
string
date_of_birth
string
relative_type
string
phone_numbers
string
note
string
notes

Notes

Array<object>
object
id
string
note_type
string
value
string
created_by
string
created_at
string
tasks

Tasks

Array<object>
object
id
string
note_type
string
value
string
done
string
custom_fields

Custom fields

Array<object>
object
id
string
name
string
type
string
values
string
average_purchase_amount

Average purchase amount

number format: double
average_products_price

Average product price

number format: double
client_type

Customer type

string
average_discount

Average discount

number format: double
average_products_count

Average number of products per receipt

number format: double
top_transaction

Largest transaction

number format: double
visits_count

Number of visits

integer format: int64
props_updated

Properties update flag

boolean
imported_debt_amount
number
imported_debt_repayment_date
string
sort
Array
nullable
Examplegenerated
{
  "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
  "external_id": "example",
  "company_id": "example",
  "first_name": "example",
  "last_name": "example",
  "middle_name": "example",
  "language": "example",
  "date_of_birth": "example",
  "gender": "example",
  "phone_numbers": [
    "example"
  ],
  "marital_status": "example",
  "registered_shop": {
    "id": "example",
    "name": "example"
  },
  "registered_shop_name": "example",
  "last_purchase_date": "example",
  "channel": {
    "id": "example",
    "company_id": "example",
    "name": "example",
    "session_id": "example"
  },
  "sms_notification": true,
  "phone_notification": true,
  "social_network_notification": true,
  "purchase_amount": 1,
  "debt_amount": 1,
  "email_notification": true,
  "groups": [
    {
      "id": "example",
      "company_id": "example",
      "name": "example",
      "session_id": "example",
      "loyalty_level_id": "example",
      "group_type": "example",
      "active": true,
      "is_auto": true,
      "description": "example",
      "external_id": "example",
      "created_at": "example",
      "discount_percent": 1,
      "customer_group_id": "example",
      "segment_conditions": [
        {}
      ],
      "customer_qty": 1,
      "works_on_retail_price": true,
      "works_on_free_price": true,
      "works_on_wholesale_price": true
    }
  ],
  "group_names": [
    "example"
  ],
  "tag_names": [
    "example"
  ],
  "cards": [
    {
      "id": "example",
      "name": "example",
      "code": "example",
      "is_active": true
    }
  ],
  "created_at": "example",
  "loyalty_program_id": "example",
  "loyalty_program_level_id": "example",
  "last_update_date": "example",
  "balance": 1,
  "company_name": "example",
  "chat_id": "example",
  "first_purchase_date": "example",
  "source_id": "example",
  "deleted_at": 1,
  "country_name": "example",
  "addresses": [
    {
      "id": "example",
      "country_id": "example",
      "city": "example",
      "address": "example",
      "postcode": "example",
      "note": "example"
    }
  ],
  "social_networks": [
    {
      "id": "example",
      "name": "example",
      "value": "example"
    }
  ],
  "relatives": [
    {
      "id": "example",
      "first_name": "example",
      "last_name": "example",
      "middle_name": "example",
      "date_of_birth": "example",
      "relative_type": "example",
      "phone_numbers": "example",
      "note": "example"
    }
  ],
  "notes": [
    {
      "id": "example",
      "note_type": "example",
      "value": "example",
      "created_by": "example",
      "created_at": "example"
    }
  ],
  "tasks": [
    {
      "id": "example",
      "note_type": "example",
      "value": "example",
      "done": "example"
    }
  ],
  "custom_fields": [
    {
      "id": "example",
      "name": "example",
      "type": "example",
      "values": "example"
    }
  ],
  "average_purchase_amount": 1,
  "average_products_price": 1,
  "client_type": "example",
  "average_discount": 1,
  "average_products_count": 1,
  "top_transaction": 1,
  "visits_count": 1,
  "props_updated": true,
  "imported_debt_amount": 1,
  "imported_debt_repayment_date": "example",
  "sort": [
    "example"
  ]
}