Flavours API
Assistance

List Assistances

GET
/api/v2/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. Must match an existing stored value.

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 "https://api.flavours.sa/dev/api/v2/assistances?page=1&per_page=20&search=John&sort=created_at&key_by=id&includes=adipisci&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": "f752ac78-7db5-4701-8865-bc408f44acd3",
        "name": "Leonora Barton",
        "phone_prefix": "90",
        "phone_number": "3716550839",
        "is_contacted": false,
        "contacted_by": null,
        "contacted_at": null,
        "created_at": 1787446681125,
        "updated_at": 1787446681125
      },
      {
        "id": "f1c401c2-c46c-4754-b16c-37a818f84138",
        "name": "Kayli Hickle",
        "phone_prefix": "965",
        "phone_number": "9723909997",
        "is_contacted": true,
        "contacted_by": null,
        "contacted_at": null,
        "created_at": 1787446681125,
        "updated_at": 1787446681125
      },
      {
        "id": "eea792a2-8956-4832-9d66-7a366351fe61",
        "name": "Mr. Cody Tillman",
        "phone_prefix": "20",
        "phone_number": "8346734610",
        "is_contacted": false,
        "contacted_by": null,
        "contacted_at": null,
        "created_at": 1787446681125,
        "updated_at": 1787446681125
      },
      {
        "id": "e9f928f5-96c0-48b1-8fff-319df0740b20",
        "name": "Arielle Gutkowski",
        "phone_prefix": "212",
        "phone_number": "1153483582",
        "is_contacted": true,
        "contacted_by": null,
        "contacted_at": null,
        "created_at": 1787446681125,
        "updated_at": 1787446681125
      },
      {
        "id": "d7947e65-631c-4c64-bb9b-76426fb8e306",
        "name": "Dr. Kolby Leffler",
        "phone_prefix": "90",
        "phone_number": "6433961882",
        "is_contacted": false,
        "contacted_by": null,
        "contacted_at": null,
        "created_at": 1787446681125,
        "updated_at": 1787446681125
      },
      {
        "id": "d6e4dc3b-2507-426c-a0fc-04f35f9f2535",
        "name": "Norval Lemke",
        "phone_prefix": "20",
        "phone_number": "5667215988",
        "is_contacted": false,
        "contacted_by": null,
        "contacted_at": null,
        "created_at": 1787446681125,
        "updated_at": 1787446681125
      },
      {
        "id": "c05c6628-6f85-4624-9249-f9393a827f3b",
        "name": "Kailyn Daniel",
        "phone_prefix": "20",
        "phone_number": "7323754065",
        "is_contacted": false,
        "contacted_by": null,
        "contacted_at": null,
        "created_at": 1787446681125,
        "updated_at": 1787446681125
      },
      {
        "id": "c029a46e-4e22-452a-81c5-d2b82bf60fd8",
        "name": "Curt Fritsch Jr.",
        "phone_prefix": "964",
        "phone_number": "9010753725",
        "is_contacted": true,
        "contacted_by": null,
        "contacted_at": null,
        "created_at": 1787446681125,
        "updated_at": 1787446681125
      },
      {
        "id": "07d776d8-6570-4a14-83c3-2ec9a36681fe",
        "name": "Kaci Homenick",
        "phone_prefix": "963",
        "phone_number": "6825367221",
        "is_contacted": false,
        "contacted_by": null,
        "contacted_at": null,
        "created_at": 1787446681125,
        "updated_at": 1787446681125
      },
      {
        "id": "0257d511-4b68-4cf0-8d94-9d697a31b850",
        "name": "Yasmine Goyette",
        "phone_prefix": "967",
        "phone_number": "9321631780",
        "is_contacted": false,
        "contacted_by": null,
        "contacted_at": null,
        "created_at": 1787446681125,
        "updated_at": 1787446681125
      }
    ],
    "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
}

Detail Assistance GET

Get details of a specific assistance request by its ID.

Attendance Stats — Order Statuses GET

Paginated on-demand breakdown of the attendance window's orders grouped by order status. full=true ignores the report filter and splits each status by transaction payment-state (PAID/UNPAID); full=false applies filter.statuses/filter.transaction and collapses to one row per status. Paginated via page/per_page.