Skip to main content
GET
/
v1
/
doctors
Get all doctors
curl --request GET \
  --url https://dev.flextell.ai/api/v1/doctors \
  --header 'Authorization: Bearer <token>' \
  --header 'X-Tenant: <x-tenant>'
{
  "data": [
    {
      "id": 123,
      "name": "<string>",
      "email": "<string>",
      "title": "<string>",
      "phone": "<string>",
      "emergency_contact_name": "<string>",
      "emergency_contact_surname": "<string>",
      "emergency_contact_phone_number": "<string>",
      "blood_group": "<string>",
      "language": [
        "<unknown>"
      ],
      "avatar_url": "<string>",
      "is_active": true,
      "bio": "<string>",
      "last_login_at": "2023-11-07T05:31:56Z",
      "last_login_ip": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "deleted_at": "2023-11-07T05:31:56Z",
      "roles": [
        {
          "id": 123,
          "name": "<string>"
        }
      ],
      "treatments": [
        {
          "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.

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,
email,
created_at,
updated_at,
last_login_at
​
sort_order
enum<string> | null

The sort direction (asc or desc).

Available options:
asc,
desc
​
is_active
boolean | null

Filter by active status.

​
trashed
boolean | null

Filter by trashed status.

​
has_calendar_integration
boolean | null

Only return doctors that have an active calendar integration.

Response

Array of DoctorResource

​
data
DoctorResource · object[]
required