JAjane
Treatments

List Treatments

Changed on

Returns a list of treatments with pagination support.

Filtering: Filter records by field values using the format: field[operator]=value

Available fields:

  • public_id: string
  • staff_member_ids: UUID string — returns treatments owned by or offered by the staff member (via available treatments)
  • created_at: ISO 8601 datetime (e.g. 2025-01-01T12:00:00Z)
  • updated_at: ISO 8601 datetime

Available operators:

  • eq: Equals
  • gt: Greater than
  • gte: Greater than or equal
  • lt: Less than
  • lte: Less than or equal

Operator restrictions:

  • public_id and staff_member_ids only support eq
  • created_at and updated_at support all operators above

Date-time filters (ex. created_at, updated_at) must:

  • Use ISO 8601 date-time format
  • Be precise to the second (e.g. 2025-01-01T12:00:00Z)

Examples:

/treatments?public_id[eq]=abc123
/treatments?created_at[gte]=2025-01-01T00:00:00Z&created_at[lt]=2025-01-02T00:00:00Z
get/api/2026-01-01/treatments

Request

  • Base URL
    https://jdpdocsdemo.jane.qa
  • URL
    https://jdpdocsdemo.jane.qa/api/2026-01-01/treatments
  • Auth
    OAuth 2
    Authorization code: https://login.id.janeapp.com/realms/jane_partner_sandbox/protocol/openid-connect/auth?response_type=code&resource=https://jdpdocsdemo.jane.qa&prompt=consent
    Token URL: https://login.id.janeapp.com/realms/jane_partner_sandbox/protocol/openid-connect/token scopes: treatments:read

Query parameters

page[cursor]string
Example:eyJwYWdlIjoyLCJzaXplIjo1fQ==

The Base64 encoded cursor to start the list from. Contains page and size information for pagination.

page[limit]integer

The number of records to return

sortstring

Comma-separated list of fields to sort by. Prefix a field with '-' for descending order.

Examples:

  • sort=name,-created_at sorts by name ascending, then created_at descending.
  • sort=-updated_at sorts by updated_at descending.

Available fields:

  • name
  • price
  • created_at
  • updated_at
eqstring

equals. Multiple equal values are comma-separated: ?field[eq]=value1,value2 (maximum 100 values)

Filter by public_id. Only supports eq. Example: public_id[eq]=123

eqstring

equals. Multiple equal values are comma-separated: ?field[eq]=value1,value2 (maximum 100 values)

Filter by staff member ID. Only supports eq. Returns treatments owned by or offered by the staff member. Example: staff_member_ids[eq]=019d8e34-8307-7b0e-b6c2-5d03ca0bfb37

eqstring date-time

equals. Multiple equal values are comma-separated: ?field[eq]=value1,value2

nestring date-time

not equals

gtstring date-time

greater than

gtestring date-time

greater than or equal to

ltstring date-time

less than

ltestring date-time

less than or equal to

Filter by created_at timestamp (ISO 8601). Example: created_at[gte]=2025-01-01T00:00:00Z

eqstring date-time

equals. Multiple equal values are comma-separated: ?field[eq]=value1,value2

nestring date-time

not equals

gtstring date-time

greater than

gtestring date-time

greater than or equal to

ltstring date-time

less than

ltestring date-time

less than or equal to

Filter by updated_at timestamp (ISO 8601). Example: updated_at[lt]=2025-01-02T00:00:00Z

Response

Treatments retrieved successfully

cursorstring nullable

The Base64 encoded cursor for the next page. null if this is the last page.

limitinteger

Number of items per page

hasNextPageboolean

Whether there is a next page of treatments

Example response

{
  "cursor": "eyJwYWdlIjozLCJzaXplIjo1fQ==",
  "links": {
    "after": "/api/2026-01-01/treatments?page[cursor]=eyJwYWdlIjozLCJzaXplIjo1fQ==&page[limit]=5"
  }
}

Changes