Oura API Endpoints

The Oura plugin provides access to Oura Ring health data including sleep, readiness, and activity summaries.

New to Corsair? Learn about core concepts like API access, authentication, and error handling.

Full Implementation: For the complete, up-to-date list, see the Oura plugin source code.

Profile

profile.get

Get the authenticated user's Oura profile and personal info.

const profile = await corsair.oura.api.profile.get({});

Parameters: None

Returns:

{
    id: string;
    age: number;
    weight: number;
    height: number;
    biological_sex: string;
    email: string;
}

summary.getActivity

Get daily activity summary data for a date range.

const activity = await corsair.oura.api.summary.getActivity({
    start_date: "2024-01-01", 
    end_date: "2024-01-07",   
});

Parameters:

Name	Type	Required	Description
`start_date`	`string`	No	Start date (YYYY-MM-DD)
`end_date`	`string`	No	End date (YYYY-MM-DD)
`next_token`	`string`	No	Pagination token

Returns: Array of daily activity objects with score, steps, calories burned, and contributors.

summary.getReadiness

Get daily readiness summary data for a date range.

const readiness = await corsair.oura.api.summary.getReadiness({
    start_date: "2024-01-01", 
    end_date: "2024-01-07",
});

Parameters:

Name	Type	Required	Description
`start_date`	`string`	No	Start date (YYYY-MM-DD)
`end_date`	`string`	No	End date (YYYY-MM-DD)
`next_token`	`string`	No	Pagination token

Returns: Array of daily readiness objects with score (0-100) and contributor scores.

summary.getSleep

Get daily sleep summary data for a date range.

const sleep = await corsair.oura.api.summary.getSleep({
    start_date: "2024-01-01", 
    end_date: "2024-01-07",
});

Parameters:

Name	Type	Required	Description
`start_date`	`string`	No	Start date (YYYY-MM-DD)
`end_date`	`string`	No	End date (YYYY-MM-DD)
`next_token`	`string`	No	Pagination token

Returns: Array of daily sleep objects with score, total sleep time, sleep stages, and contributors.