Skip to main content

Get user notes

GET 
/:customer_id/users/:uid/notes

Get user notes with filters

Request​

Path Parameters

    customer_id Customer Idrequired

    Id of the tenant

    uid uuidrequired

    Id of the user

Query Parameters

    limit Limit

    Possible values: <= 1000

    Default value: 100

    Pagination. Max number of entries returned.

    offset Offset

    Pagination. Offset.

    start_date date-time

    Notes start date, timestamptz

    end_date date-time

    Notes end date, timestamptz

    triggers_id string[]

    A list of triggers

    direction Direction

    Possible values: [asc, desc]

    Default value: desc

    Ascending or descending in time

Responses​

Successful response

Schema
    id uuid4required

    The primary key for the note, a unique identifier.

    customer_id Customer Idrequired

    The FK linking the note to a specific tenant

    uid uuid4required

    The FK linking the note to a specific user.

    start_date date-timerequired

    The timestamp indicating when the note's started, with timezone information.

    end_date date-timerequired

    The timestamp indicating when the note's ended, with timezone information.

    text Textrequired

    Text field containing text related to the note.

    triggers_id string[]required

    A list of trigger identifiers that triggered this note.

    cough_count Cough Countnullable

    The total number of coughs observed during the note's time frame.

    cough_rate Cough Ratenullable

    The rate of coughs observed, typically calculated as coughs per minute.

    created_at date-time

    The timestamp when the note was created, set automatically.

    updated_at date-time

    The timestamp when the note was last updated, set automatically.

    utc_offset Utc Offsetrequired

    Note's timezone offset in minutes

    notes object[]required
  • Array [
    • id uuid4required

    The primary key for the note, a unique identifier.

    customer_id Customer Idrequired

    The FK linking the note to a specific tenant

    uid uuid4required

    The FK linking the note to a specific user.

    start_date date-timerequired

    The timestamp indicating when the note's started, with timezone information.

    end_date date-timerequired

    The timestamp indicating when the note's ended, with timezone information.

    text Textrequired

    Text field containing text related to the note.

    triggers_id string[]required

    A list of trigger identifiers that triggered this note.

    cough_count Cough Countnullable

    The total number of coughs observed during the note's time frame.

    cough_rate Cough Ratenullable

    The rate of coughs observed, typically calculated as coughs per minute.

    created_at date-time

    The timestamp when the note was created, set automatically.

    updated_at date-time

    The timestamp when the note was last updated, set automatically.

    utc_offset Utc Offsetrequired

    Note's timezone offset in minutes

  • ]
Loading...