---
title: "Get a paged array of support-activities"
method: GET
path: "/support-activities"
tags: ["support-activity"]
---

# Get a paged array of support-activities

`GET /support-activities`

Get a paged array of support-activities

## Query parameters

- `id_gt` integer, nullable — The starting object id of the next page
- `id_lt` integer, nullable — The starting object id of the previous page
- `update_gt` union — Search for objects updated after this date time
  - string
  - string
- `update_lt` union — Search for objects updated before this date time
  - string
  - string
- `include_archived` 'true' | 'false', nullable — Whether archived objects should be retrieved, default is false
- `start_gt` string, nullable — Search for support activities start after this date time
- `start_lt` string, nullable — Search for support activities start before this date time
- `patientId` number, nullable — Search for support activities with this patient id

## Response `200`

A paged array of support-activities

- object
  - `data` object[], required
    - `id` integer, required — Support activity id
    - `start` union, required — Support activity start date time
      - string
      - string
    - `end` union, required — Support activity start date time
      - string
      - string
    - `patientId` integer, required — Patient id
    - `practitionerId` integer, required — The practitioner id of this support activity
    - `serviceId` integer, required — The service id of this support activity
    - `locationId` integer, required — The location id of this support activity
    - `caseId` integer, nullable, required — The case id of this support activity
    - `note` string, nullable, required — Note for the support activity
    - `itemCode` string, nullable, required — Item code for the support activity
    - `repeatId` string, nullable, required — An recurring support activity will have this repeat id
    - `recurringRule` string, nullable, required — The rule for recurring support activity
    - `unit` string, nullable, required — The support activity unit
    - `pricing` number, nullable, required — The support activity unit price, in dollar
    - `quantity` number, nullable, required — The support activity quantity
    - `taxType` union, required — Tax type, check Splose support for more info
      - 'STANDARD' | 'ZERO' | 'EXEMPT' | 'REDUCED'
      - string
      - unknown
    - `doNotInvoice` boolean, nullable — Whether this support activity patient will not be invoiced
    - `invoiceId` integer, nullable, required — Invoice id of this support activity patient
    - `archived` boolean, nullable — Whether the support activity has been archived
    - `createdAt` union — Object creation date time
      - string
      - string
    - `updatedAt` union — Object update date time
      - string
      - string
    - `deletedAt` union, required — Object archived date time
      - string
      - string
      - unknown
  - `links` object, required
    - `previousPage` string — The link to retrieve next page
    - `nextPage` string — The link to retrieve previous page

---

[API](https://skmtc.dev/splose/apis/splose-public-api.md) · [All operations](https://skmtc.dev/splose/apis/splose-public-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/splose/splose-public-api/revisions/648d60075f00/schema)
