PAI Health logo

Developers

PAI Health API - Program

Download OpenAPI specification:Download

PAI Health Program services

Authentication

vpcProgramAuthorizer

Security Scheme Type API Key
Header parameter name: Authorization

Biometrics

CORS support

Enable CORS preflight requests

path Parameters
organizationId
required
string <uuid>

Organization Id this resource belongs to.

programId
required
string <uuid>

The id of this resource.

Responses

Get all biometrics

Returns a paged list of biometrics according to filters and sort order.

Authorizations:
path Parameters
organizationId
required
string <uuid>

Organization Id this resource belongs to.

programId
required
string <uuid>

The id of this resource.

query Parameters
limit
integer [ 1 .. 1000 ]
Default: 20

The number of items to limit the query to. Defaults to 20, maximum is 1000.

offset
integer >= 0
Default: 0

The number of items to skip when querying. Defaults to 0.

fields
Array of strings

Selected fields to be returned. By default all fields will be returned.

  • /resourceUrl?fields=field1,field2
sort
Array of strings

Fields to sort results by. The field name can optionally be prepended with '-' sign to indicate descending ordering. The default is ascending and sort order is applied from left to right.

q
string <= 1000 characters

Advanced filter query, supports more operators [>, >=, !-, <. <=, IN, NOT IN, LIKE] than simple filters.

  • /resourceUrl?q=field1 >= 2017-09-27T22:39:28Z AND (field2=someValue OR field3 IN [1,2,3])

Multiple filters are delimited with the "AND" or "OR" keywords and may be nested with ().

userId
required
string <uuid>

Filter by the userId

calendarDay
string <date>

Filter by calendarDay

biometricType
string
Enum: "MaxHR" "SleepRHR" "AwakeRHR" "Height" "Weight" "BirthDate" "Sex"

Filter by biometricType.

source
string

Filter by source.

sourceProvider
string

Filter by source provider.

createdBy
string <uuid>

Filter by createdBy.

createdAt
string <date-time>

Filter by createdAt.

modifiedBy
string <uuid>

Filter by modifiedBy.

modifiedAt
string <date-time>

Filter by modifiedAt.

Responses

CORS support

Enable CORS preflight requests

path Parameters
organizationId
required
string <uuid>

Organization Id this resource belongs to.

programId
required
string <uuid>

The id of this resource.

asOfDate
required
string <date>

Gets latest biometrics before or on this date

Responses

Get latest biometric as of the asOfDate of each type for all users

Returns a paged list of latest biometrics according to filters and sort order.

Authorizations:
path Parameters
organizationId
required
string <uuid>

Organization Id this resource belongs to.

programId
required
string <uuid>

The id of this resource.

asOfDate
required
string <date>

Gets latest biometrics before or on this date

query Parameters
limit
integer [ 1 .. 1000 ]
Default: 20

The number of items to limit the query to. Defaults to 20, maximum is 1000.

offset
integer >= 0
Default: 0

The number of items to skip when querying. Defaults to 0.

fields
Array of strings

Selected fields to be returned. By default all fields will be returned.

  • /resourceUrl?fields=field1,field2
sort
Array of strings

Fields to sort results by. The field name can optionally be prepended with '-' sign to indicate descending ordering. The default is ascending and sort order is applied from left to right.

q
string <= 1000 characters

Advanced filter query, supports more operators [>, >=, !-, <. <=, IN, NOT IN, LIKE] than simple filters.

  • /resourceUrl?q=field1 >= 2017-09-27T22:39:28Z AND (field2=someValue OR field3 IN [1,2,3])

Multiple filters are delimited with the "AND" or "OR" keywords and may be nested with ().

id
string <uuid>

Filter by resource id.

userId
required
string <uuid>

Filter by the userId

calendarDay
string