Skip to main content
GET
/
v1
/
treatments
Get all treatments
curl --request GET \
  --url https://dev.flextell.ai/api/v1/treatments \
  --header 'Authorization: Bearer <token>' \
  --header 'X-Tenant: <x-tenant>'
{
  "data": [
    {
      "id": 123,
      "group_id": 123,
      "name": "<string>",
      "keywords": [
        "<unknown>"
      ],
      "price": "<string>",
      "tax_rate": 123,
      "description": "<string>",
      "session": 123,
      "is_active": "<string>",
      "extra_info": {},
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "deleted_at": "2023-11-07T05:31:56Z",
      "group": {
        "id": 123,
        "name": "<string>",
        "is_active": true
      },
      "users": [
        {
          "id": 123,
          "name": "<string>"
        }
      ],
      "sessions": [
        {
          "id": 123,
          "session_order": 123,
          "next_gap_days": 123,
          "offset_days": 123,
          "products": [
            {
              "id": 123,
              "product_id": 123,
              "min_quantity": 123,
              "product": {
                "id": 123,
                "name": "<string>",
                "full_name": "<string>",
                "brand": {
                  "id": 123,
                  "name": "<string>"
                },
                "unit_code": {
                  "id": "<string>",
                  "name": "<string>",
                  "code": "<string>"
                }
              }
            }
          ]
        }
      ]
    }
  ],
  "links": {
    "first": "<string>",
    "last": "<string>",
    "prev": "<string>",
    "next": "<string>"
  },
  "meta": {
    "current_page": 2,
    "from": 2,
    "last_page": 2,
    "links": [
      {
        "url": "<string>",
        "label": "<string>",
        "active": true
      }
    ],
    "path": "<string>",
    "per_page": 1,
    "to": 2,
    "total": 1
  }
}

Authorizations

Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Headers

X-Tenant
number
required

Tenant identifier. Send the Tenant ID in the X-Tenant header to scope API requests to a specific tenant.

Query Parameters

search
string | null

The search query.

Maximum string length: 255
per_page
integer | null

The number of items per page.

Required range: 1 <= x <= 100
page
integer | null

The page number.

Required range: x >= 1
sort_by
enum<string> | null

The field to sort by.

Available options:
name,
price,
session,
is_active,
created_at,
updated_at
sort_order
enum<string> | null

The sort direction (asc or desc).

Available options:
asc,
desc
is_active
boolean | null

Filter by active status.

min_price
number | null

Filter by minimum price.

Required range: x >= 0
max_price
number | null

Filter by maximum price.

Required range: x >= 0
group_id
integer | null

Filter by treatment group.

trashed
boolean | null

Filter by trashed status.

Response

Paginated set of TreatmentResource

data
TreatmentResource · object[]
required
meta
object
required