The Aryeo API provides access to the Aryeo platform.
https://docs.aryeo.com/_mock/api/aryeo/
https://api.aryeo.com/v1/
https://docs.aryeo.com/_mock/api/aryeo/blocks
https://api.aryeo.com/v1/blocks
const resp = await fetch(
`https://docs.aryeo.com/_mock/api/aryeo/blocks`,
{
method: 'POST',
headers: {
Authorization: 'Bearer <YOUR_TOKEN_HERE>'
}
}
);
const data = await resp.text();
console.log(data);https://docs.aryeo.com/_mock/api/aryeo/blocks/{block_id}
https://api.aryeo.com/v1/blocks/{block_id}
const blockId = '00000000-0000-4000-8000-000000000000';
const resp = await fetch(
`https://docs.aryeo.com/_mock/api/aryeo/blocks/${blockId}`,
{
method: 'DELETE',
headers: {
Authorization: 'Bearer <YOUR_TOKEN_HERE>'
}
}
);
const data = await resp.text();
console.log(data);https://docs.aryeo.com/_mock/api/aryeo/blocks/{block_id}
https://api.aryeo.com/v1/blocks/{block_id}
const blockId = '00000000-0000-4000-8000-000000000000';
const resp = await fetch(
`https://docs.aryeo.com/_mock/api/aryeo/blocks/${blockId}`,
{
method: 'GET',
headers: {
Authorization: 'Bearer <YOUR_TOKEN_HERE>'
}
}
);
const data = await resp.text();
console.log(data);https://docs.aryeo.com/_mock/api/aryeo/blocks/{block_id}
https://api.aryeo.com/v1/blocks/{block_id}
const blockId = '00000000-0000-4000-8000-000000000000';
const resp = await fetch(
`https://docs.aryeo.com/_mock/api/aryeo/blocks/${blockId}`,
{
method: 'PUT',
headers: {
Authorization: 'Bearer <YOUR_TOKEN_HERE>'
}
}
);
const data = await resp.text();
console.log(data);https://docs.aryeo.com/_mock/api/aryeo/regions
https://api.aryeo.com/v1/regions
const resp = await fetch(
`https://docs.aryeo.com/_mock/api/aryeo/regions`,
{
method: 'GET',
headers: {
Authorization: 'Bearer <YOUR_TOKEN_HERE>'
}
}
);
const data = await resp.text();
console.log(data);https://docs.aryeo.com/_mock/api/aryeo/scheduling/assignment
https://api.aryeo.com/v1/scheduling/assignment
const resp = await fetch(
`https://docs.aryeo.com/_mock/api/aryeo/scheduling/assignment`,
{
method: 'GET',
headers: {
Authorization: 'Bearer <YOUR_TOKEN_HERE>'
}
}
);
const data = await resp.text();
console.log(data);The IDs of users whose availability will be listed. UUID Version 4.
Appointment ID used to list availability for an existing order
Returns availability after start_at
Returns availability before end_at
Returns availability for a specific timeframe. Used instead of start_at & end_at
Duration of the event to schedule. Required if appointment_id isn't specified
Interval of bookable timeslots starting at x minutes on the hour . Required if appointment_id isn't specified
The timezone of the client. Available dates results will be localized to this timezone
The requested page of results. Use this parameter to flip through pages when using the timeframe filter
https://docs.aryeo.com/_mock/api/aryeo/scheduling/available-dates
https://api.aryeo.com/v1/scheduling/available-dates
const query = new URLSearchParams({timezone: 'CST'}).toString();
const resp = await fetch(
`https://docs.aryeo.com/_mock/api/aryeo/scheduling/available-dates?${query}`,
{
method: 'GET',
headers: {
Authorization: 'Bearer <YOUR_TOKEN_HERE>'
}
}
);
const data = await resp.text();
console.log(data);{ "status": "success", "data": [ { "date": "2021-01-01", "is_available": true } ], "meta": { "group_id": "00000000-0000-4000-8000-000000000000", "company_id": "00000000-0000-4000-8000-000000000000", "company_team_member_ids": [ "00000000-0000-4000-8000-000000000000" ], "user_ids": [ "00000000-0000-4000-8000-000000000000" ], "appointment_id": "00000000-0000-4000-8000-000000000000", "start_at": "2021-06-30T20:30:00Z", "end_at": "2021-06-30T21:30:00Z", "timezone": "CST", "is_twilight": true, "interval": 30, "duration": 30, "current_page": 1, "timeframe": "DAY", "timeframe_period": { "startDate": "2025-04-01T05:59:59.999999Z", "endDate": "2025-04-01T05:59:59.999999Z", "startDateIncluded": true, "endDateIncluded": true }, "from": 1, "last_page": 4, "links": [ { "url": "https://admin.aryeo.test/api/v1/companies?page=2", "label": "2", "active": true } ], "path": "https://api.aryeo.com/v1/{path}", "per_page": 15, "to": 15, "total": 50 }, "links": { "first": "https://api.aryeo.com/v1/{path}?page=1", "last": "https://api.aryeo.com/v1/{path}?page=10", "prev": "https://api.aryeo.com/v1/{path}?page=2", "next": "https://api.aryeo.com/v1/{path}?page=3" }, "timestamp": "2021-06-30T20:30:00Z" }
The IDs of users whose appointments will be listed. UUID Version 4.
Appointment ID used to list availability for an existing order
Duration of the event to schedule. Required if appointment_id isn't specified
Interval of bookable timeslots starting at x minutes on the hour . Required if appointment_id isn't specified
The number of results per page. Only applies when using a date range
The date to list available timeslots
https://docs.aryeo.com/_mock/api/aryeo/scheduling/available-timeslots
https://api.aryeo.com/v1/scheduling/available-timeslots
const query = new URLSearchParams({
date: '2021-01-01',
timezone: 'CST'
}).toString();
const resp = await fetch(
`https://docs.aryeo.com/_mock/api/aryeo/scheduling/available-timeslots?${query}`,
{
method: 'GET',
headers: {
Authorization: 'Bearer <YOUR_TOKEN_HERE>'
}
}
);
const data = await resp.text();
console.log(data);{ "status": "success", "data": [ { "start_at": "2021-01-01T00:00:00Z", "end_at": "2021-01-01T00:30:00Z", "users": [ { "object": "PERSONAL_ACCESS_TOKEN", "id": "00000000-0000-4000-8000-000000000000", "email": "john.doe@gmail.com", "first_name": "John", "last_name": "Doe", "full_name": "John Doe", "internal_notes": "Internal notes for the user.", "status": "active", "phone": "123456789", "avatar_url": "https://picsum.photos/300", "relationship": "owner", "sso_users": [ … ], "is_super": true } ] } ], "meta": { "group_id": "00000000-0000-4000-8000-000000000000", "company_id": "00000000-0000-4000-8000-000000000000", "company_team_member_ids": [ "00000000-0000-4000-8000-000000000000" ], "user_ids": [ "00000000-0000-4000-8000-000000000000" ], "appointment_id": "00000000-0000-4000-8000-000000000000", "start_at": "2021-06-30T20:30:00Z", "end_at": "2021-06-30T21:30:00Z", "timezone": "CST", "is_twilight": true, "interval": 30, "duration": 30, "current_page": 1, "timeframe": "DAY", "timeframe_period": { "startDate": "2025-04-01T05:59:59.999999Z", "endDate": "2025-04-01T05:59:59.999999Z", "startDateIncluded": true, "endDateIncluded": true }, "from": 1, "last_page": 4, "links": [ { "url": "https://admin.aryeo.test/api/v1/companies?page=2", "label": "2", "active": true } ], "path": "https://api.aryeo.com/v1/{path}", "per_page": 15, "to": 15, "total": 50 }, "links": { "first": "https://api.aryeo.com/v1/{path}?page=1", "last": "https://api.aryeo.com/v1/{path}?page=10", "prev": "https://api.aryeo.com/v1/{path}?page=2", "next": "https://api.aryeo.com/v1/{path}?page=3" }, "timestamp": "2021-06-30T20:30:00Z" }
https://docs.aryeo.com/_mock/api/aryeo/scheduling/item-groupings
https://api.aryeo.com/v1/scheduling/item-groupings
const resp = await fetch(
`https://docs.aryeo.com/_mock/api/aryeo/scheduling/item-groupings`,
{
method: 'GET',
headers: {
Authorization: 'Bearer <YOUR_TOKEN_HERE>'
}
}
);
const data = await resp.text();
console.log(data);