Search Of The Contact List
Method for searching the list of contacts. In the search, it is possible to use operations: like, =, >, >=, <, <=
Search is possible by the following fields:
- name: like,=
- description: like,=
- date: =,>,>=,<,<=
- items: =,>,>=,<,<=.
- phone: like,=
- id: =,>,>=,<,<=
Request URL
GET http://one-api.bsg.world/api/groups/search
Request Parameters
| Parameter | Required | Type | Default | Description | ||||||||||||
| page[offset] | No | integer | 0 | Get contact groups starting from offset | ||||||||||||
| page[limit] | No | integer | 30 | Number of contact groups in the response | ||||||||||||
| sort | No | string | id | Sort by conditions: id, items, name, description, date | ||||||||||||
| way | No | string | asc | Sorting options: asc, desc | ||||||||||||
| search[operation] | No | string | No | Operator for finding values: like, =, >, >=, <, <= | ||||||||||||
| search[field] | No | string | No | Field for search: name, items, date, description, phone, id | ||||||||||||
| search[value] | No | string | No |
Value for search:
|
Response Parameters
| Parameter | Type | Description |
| id | integer | List ID |
| name | string | List name |
| description | string | List description |
| is_default | boolean | Whether the list is the default. Possible values: true, false |
| items | integer | Number of contacts in the list |
| created_at | string | Date and time the list was created. Format ISO 8601 yyyy-mm-dd hh:mm:ss |
Response Sample
If the request is successful, you will receive a response:
{
"data": [
{
"id": 1,
"name": "string",
"description": "string",
"is_default": true,
"items": 0,
"created_at": "2022-04-28 14:21:16"
}
],
"meta": {
"page": {
"total": 1,
"offset": 20,
"limit": 40
},
"search": {
"field": "id",
"operation": "like",
"value": "string"
}
}
}
Comments
0 comments
Article is closed for comments.