A List response is a type of response that returns a list of elements.
Header
| Field Name | Type | Description |
|---|
| version | Mavryx/Types/Integer | Microservice API version |
| endpoint | Mavryx/Types/String | The responding endpoint (typically the one that was called). |
| referer | Mavryx/Types/String | Requester who called the endpoint. |
| raycast | Mavryx/Types/String | Request tracking identifier |
| request_id | Mavryx/Types/String | Request identifier |
| response_id | Mavryx/Types/String | Response identifier |
| status | Mavryx/Types/Integer | Response status (the response code may not comply with HTTP error codes). |
| message | Mavryx/Types/String | Response message |
Response
| Field Name | Type | Description |
|---|
response_type | Const | It defines whether a single object, a list of objects, or a basic type has been returned. The possible values are: list, item, simple |
type | Object Type or Simple Type | The type of the returned object |
list | Mavryx/Types/Array | If a list of objects is returned, this field contains the list of objects. |
| items_count | Mavryx/Types/Integer | How many items was returned |
| filtered_count | Mavryx/Types/Integer | How many items fit to the query |
| total_count | Mavryx/Types/Integer | How many items is in DB |
Query parameters
| Field Name | Type | Description |
|---|
| q | Mavryx/Types/String | Query |
| a[] | Mavryx/Types/Array | Arguments |
| sort[] | Mavryx/Types/Array | Sort |
| start | Mavryx/Types/Integer | Start from |
| limit | Mavryx/Types/Integer | How many items to return (default: 50) |
Example query
| Field Name | Value | Description |
|---|
| q | q=first_name = :first_name: | The query |
| a[] | a[first_name]=john | Arguments for query |
| sort[] | sort[]=created_time ASC | Sort |
| start | 1 | |
| limit | 25 | |
https://accounts-dev.mavryx.solutions/account/list?q=first_name%20%3D%20%3Afirst_name%3A&a[first_name]=john&sort[]=created_time%20ASC&start=1&limit=24
Example response
{
"header": {
"version": 20240101,
"endpoint": "/account/list",
"referer": "https://swagger-dev.mavryx.software",
"raycast": "5d06f2af11af3b71ddae73a827fbc32d",
"request_id": "0bffb5478ea1f203e1ec75b1a138e905",
"response_id": "b474beeb6f8d8226fd487a71d362ebef",
"status": 200,
"message": "OK"
},
"response": {
"response_type": "list",
"type": "Mavryx/Account",
"items_count": 4,
"filtered_count": 4,
"total_count": 4,
"list": [
{
"uuid": "069aa47b-1dd8-4273-8dsa-1b4dadea8ff4",
"type": "Mavryx/Account",
"created_time": 1571156658,
"updated_time": null,
"deleted_time": null,
"is_active": true,
"email": "dsadsa@tterewr.com",
"first_name": "dsada",
"last_name": "dsadas"
},
{
"uuid": "10e06a62-efd2-4297-84f8-2b5fb0aaca4c",
"type": "Mavryx/Account",
"created_time": 1571104277,
"updated_time": null,
"deleted_time": null,
"is_active": true,
"email": "ddddd@xxxx.pl",
"first_name": "dsadsa",
"last_name": "dsadsa"
},
{
"uuid": "18cf30b0-efea-4763-ae4f-75e1a3a82c88",
"type": "Mavryx/Account",
"created_time": 1663328309,
"updated_time": null,
"deleted_time": null,
"is_active": true,
"email": "xxxx@xxxx.pl",
"first_name": "dsdsd",
"last_name": "dddasd"
},
{
"uuid": "1935eb6f-aaaa-46de-95e3-6075f724649c",
"type": "Mavryx/Account",
"created_time": 1571156958,
"updated_time": null,
"deleted_time": null,
"is_active": true,
"email": "yyyy@yyyy.com",
"first_name": "aadsad",
"last_name": "dsadsad"
}
]
}
}