Skip to main content
GET
/
v1
/
treatments
/
{id}
Get a treatment
curl --request GET \
  --url https://dev.flextell.ai/api/v1/treatments/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'X-Tenant: <x-tenant>'
{
  "success": "<string>",
  "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>"
              }
            }
          }
        ]
      }
    ]
  }
}

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.

Path Parameters

id
integer
required

The treatment identifier

Response

success
string
required
data
TreatmentResource · object
required