sdk.toi.get()

elements.sdk.api.toi

Get information about TOIs.

Retrieve the TOI for the specified toi_id. The user must have permission to access the specified TOI.

Parameters

  • ids (List[str]) - list of TOI IDs
  • [Optional] page_size (int) - set the number of items to return per page of results

Returns

List[TOI]

Examples

# Get a TOI
await sdk.toi.get("098ac9b8-11f2-455a-ae6e-b391319c78f2")

# 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"]