sdk.toi.list()

Retrieves the TOI for all TOIs that the user has permissions for and that match the provided search filters.

Parameters

[Optional] search_text (str) - text to search for in a TOI object
[Optional] pagination (Pagination) - Pagination object only with page size field set

Returns

List[TOI]

Examples

# Returns all TOIs that have text matching the search text field
await sdk.api.toi.list(search_text="Toi Text")

# Returns all TOIs available to the user
await sdk.api.toi.list()

# Paginated return - sets number of objects per page
await sdk.api.toi.list(pagination=Pagination(page_size=10))

# Output (List[TOI])
[id: "098ac9b8-11f2-455a-ae6e-b391319c78f2"
start_local {
  seconds: 1577836800
}
finish_local {
  seconds: 1609372800
}
recurrences {
  id: "1bb4d6cd-feb7-4c20-a445-783d50fb38da"
  rule: "FREQ=DAILY;INTERVAL=1"
  duration {
    frequency: DAILY
    value: 1
  }
}
description: "A basic TOI object"
]