Перейти к основному содержанию
GET
/
v1
/
crm
/
clients
cURL
curl --request GET \
  --url https://api.example.com/v1/crm/clients/
{
  "count": 123,
  "results": [
    {
      "id": 123,
      "ticks": [
        {
          "id": 123,
          "tick": 123,
          "created_at": "2023-11-07T05:31:56Z"
        }
      ],
      "bonus": {
        "id": 123,
        "created_at": "2023-11-07T05:31:56Z",
        "amount": "<string>"
      },
      "orders_count": 123,
      "orders_amount": "<string>",
      "orders_paid_amount": "<string>",
      "orders_debt_amount": "<string>",
      "overdue_rentals_amount": "<string>",
      "transfer_count": 123,
      "transfer_amount": "<string>",
      "last_rent_date": "2023-11-07T05:31:56Z",
      "total_time": "<string>",
      "iin": "<string>",
      "bin": "<string>",
      "balance": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>",
      "phone": "<string>",
      "agreement_id": "<string>",
      "type": 0,
      "legal_type": 0,
      "gender": 0,
      "comment": "<string>",
      "avatar": "<string>",
      "email": "jsmith@example.com",
      "deposit": "<string>",
      "signed": true,
      "sign_date": "2023-12-25",
      "sign_expires": "2023-12-25",
      "deleted_at": "2023-11-07T05:31:56Z",
      "extra": "<unknown>",
      "deleted": true,
      "tenant": 123,
      "legal_passport": 123,
      "individual_passport": 123,
      "attraction": 123,
      "discount": 123,
      "user": 123
    }
  ],
  "next": "http://api.example.org/accounts/?page=4",
  "previous": "http://api.example.org/accounts/?page=2"
}

Параметры запроса

​
attraction
integer
​
attraction__in
integer[]

Несколько значений могут быть разделены запятыми.

​
deleted
boolean
​
individual_passport__iin
string
​
individual_passport__iin__icontains
string
​
legal_passport__bin
string
​
legal_passport__bin__icontains
string
​
legal_type
enum<integer> | null
  • 0 - ИП
  • 1 - ТОО
  • 2 - АО
  • 3 - ПК
Доступные опции:
0,
1,
2,
3
​
name
string
​
name__icontains
string
​
ordering
string

Which field to use when ordering the results.

​
page
integer

A page number within the paginated result set.

​
pageSize
integer

Number of results to return per page.

​
phone
string
​
phone__icontains
string
​
phone__in
string[]

Несколько значений могут быть разделены запятыми.

​
search
string

A search term.

​
signed
boolean
​
ticks
integer[]
​
ticks__in
integer[]

Несколько значений могут быть разделены запятыми.

​
type
enum<integer>
  • 0 - Физ. лицо
  • 1 - Юр. лицо
Доступные опции:
0,
1

Ответ

200 - application/json
​
count
integer
обязательно
Пример:

123

​
results
object[]
обязательно
​
next
string<uri> | null
Пример:

"http://api.example.org/accounts/?page=4"

​
previous
string<uri> | null
Пример:

"http://api.example.org/accounts/?page=2"