Assistance
List Assistances
List all assistance requests with pagination and filtering options.
Authorization
default AuthorizationBearer <token>
You can retrieve your token by logging in.
In: header
Query Parameters
page?|
Page number for pagination. Must be at least 1.
per_page?|
Number of items per page. Must be at least 1.
search?|
Search term for filtering assistances.
sort?|
Sort column (e.g. created_at, name).
key_by?|
Key response by column.
includes*array<>
filter?object
filter.is_contacted?|
Filter by contacted status.
filter.contacted_by?|
Filter by user ID who contacted. The id of an existing record in the users table.
Header Parameters
X-API-Version*string
API contract version to target. See the Changelog for what changed in each version.
Default
"2.0.0"Value in
"2.3.0" | "2.2.0" | "2.1.0" | "2.0.0"Response Body
application/json
application/json
application/json
application/json
application/json
curl -X GET "http://localhost:8000/api/v2/assistances?page=1&per_page=20&search=John&sort=created_at&key_by=id&includes=sint&filter.is_contacted=true&filter.contacted_by=uuid" \ -H "X-API-Version: 2.3.0"{
"meta": {
"code": 200,
"status": "success",
"message": "Data Loaded Successfully"
},
"data": {
"current_page": 1,
"current_page_url": "http://localhost:8000/api/v2/assistances?page=1",
"data": [
{
"id": "dbaa05b9-e6ee-4d2b-964d-0f3a64de135a",
"name": "Prof. Adrian Schaden Jr.",
"phone_prefix": "967",
"phone_number": "4019218370",
"is_contacted": true,
"contacted_by": null,
"contacted_at": null,
"created_at": 1782824831803,
"updated_at": 1782824831803
},
{
"id": "cc91569c-6799-4e63-812e-b52daf629bcb",
"name": "Skye Lehner Sr.",
"phone_prefix": "962",
"phone_number": "2869927188",
"is_contacted": false,
"contacted_by": null,
"contacted_at": null,
"created_at": 1782824831803,
"updated_at": 1782824831803
},
{
"id": "cb131022-1a37-455d-81fc-0b816b418183",
"name": "Ruthie Nolan III",
"phone_prefix": "964",
"phone_number": "2083311471",
"is_contacted": true,
"contacted_by": null,
"contacted_at": null,
"created_at": 1782824831803,
"updated_at": 1782824831803
},
{
"id": "897c5031-4208-4259-bfe9-3a1ae3ae1ccb",
"name": "Audie Skiles",
"phone_prefix": "961",
"phone_number": "1951450020",
"is_contacted": false,
"contacted_by": null,
"contacted_at": null,
"created_at": 1782824831803,
"updated_at": 1782824831803
},
{
"id": "7fcdea1c-bca2-4589-bb59-dd33e60180d6",
"name": "Keenan Strosin",
"phone_prefix": "964",
"phone_number": "7330941301",
"is_contacted": false,
"contacted_by": null,
"contacted_at": null,
"created_at": 1782824831803,
"updated_at": 1782824831803
},
{
"id": "7588fa09-f223-4aed-a879-7853b4bf509e",
"name": "Roberta Brown DVM",
"phone_prefix": "212",
"phone_number": "3955313325",
"is_contacted": false,
"contacted_by": null,
"contacted_at": null,
"created_at": 1782824831803,
"updated_at": 1782824831803
},
{
"id": "67c986ac-41f0-48ae-ac9d-10c62a8e2f48",
"name": "Raul McGlynn",
"phone_prefix": "966",
"phone_number": "4132957829",
"is_contacted": false,
"contacted_by": null,
"contacted_at": null,
"created_at": 1782824831803,
"updated_at": 1782824831803
},
{
"id": "581dca83-916c-4a72-bcaa-37136b6f2ff7",
"name": "Dana Parisian",
"phone_prefix": "966",
"phone_number": "4092145039",
"is_contacted": true,
"contacted_by": null,
"contacted_at": null,
"created_at": 1782824831803,
"updated_at": 1782824831803
},
{
"id": "396ea79a-5283-45e9-be56-a53145dafde6",
"name": "Dr. Maritza Davis",
"phone_prefix": "971",
"phone_number": "1228425594",
"is_contacted": false,
"contacted_by": null,
"contacted_at": null,
"created_at": 1782824831803,
"updated_at": 1782824831803
},
{
"id": "276eed82-040b-4182-88c9-e44b636a60d7",
"name": "Prof. Bart Halvorson PhD",
"phone_prefix": "967",
"phone_number": "0955426882",
"is_contacted": true,
"contacted_by": null,
"contacted_at": null,
"created_at": 1782824831803,
"updated_at": 1782824831803
}
],
"first_page_url": "http://localhost:8000/api/v2/assistances?page=1",
"from": 1,
"next_page_url": null,
"path": "http://localhost:8000/api/v2/assistances",
"per_page": 20,
"prev_page_url": null,
"to": 10
}
}{
"meta": {
"code": 401,
"status": "error",
"message": "Unauthenticated."
},
"data": null
}{
"meta": {
"code": 403,
"status": "error",
"message": "Unauthorized."
},
"data": null
}{
"meta": {
"code": 404,
"status": "error",
"message": "Resource not found."
},
"data": null
}{
"meta": {
"code": 500,
"status": "error",
"message": "Internal server error."
},
"data": null
}