Skip to content
API Reference
/
/
List schedule item groupi...

Aryeo (1.0.0)

Introduction

The Aryeo API provides access to the Aryeo platform.

Overview
URL
https://www.aryeo.com
Admin
jarrodp@zillowgroup.com
License
Apache 2.0
Terms of Service
Languages
Servers
Mock server
https://docs.aryeo.com/_mock/api/aryeo
Production
https://api.aryeo.com/v1

Addresses

Operations related to addresses. Addresses provide standardized address data.

Operations

Appointments

Operations related to appointments. Appointments are bookings for services that can be rescheduled, cancelled, and confirmed.

Operations

Company Users

Operations related to company users. Companies capture media for their customers. Company users represent photographers, videographers, administrators, and other staff.

Operations

Customer Users

Operations related to customer users. Customers receive media from companies. Customer users represent real-estate agents, assistants, listing coordinators, and brokerage members.

Operations

Discounts

Operations related to discounts. Discounts support percentage or fixed-amount discounts, and coupon codes.

Operations

Listings

Operations related to listings. Listings are the core entity that connects properties with media services.

Operations

Notes

Operations related to notes. Notes are contextual comments across various entities including orders, listings, customers, and appointments.

Operations

Order Forms

Operations related to order forms. Order forms are the customer-facing booking interfaces for service requests, product selection, and appointment scheduling.

Operations

Order Items

Operations related to order items. Order items are the individual line items within orders.

Operations

Orders

Operations related to orders. Orders are the service orders from customers.

Operations

Payroll

Operations related to payroll.

Operations

Products

Operations related to products. Products consist of the categories and offerings for services and products.

Operations

Scheduling

Operations related to scheduling. Scheduling operations provide information about service provider availability.

Operations

Create block.

Request

Create block.

undocumented: false
external: true
Security
Token
Bodyapplication/json

BlockPostPayload

company_team_member_idsArray of strings or null(uuid)

The IDs of the company team members assigned to the block.

Example: ["123e4567-e89b-12d3-a456-426614174000"]
user_idsArray of strings or null(uuid)

The IDs of the users assigned to the block.

Example: ["123e4567-e89b-12d3-a456-426614174000"]
start_atstring(date-time)= 20 charactersrequired

The start time of the block (ISO 8601 format).

Example: "2020-10-04T12:15:00Z"
end_atstring(date-time)= 20 charactersrequired

The end time of the block (ISO 8601 format).

Example: "2020-10-04T12:30:00Z"
titlestring[ 0 .. 255 ] charactersrequired

The title of the block.

Example: "Other appointment"
descriptionstring or null[ 0 .. 2000 ] characters

The description of the block.

Example: "This is a description of the block."
const resp = await fetch(
  `https://docs.aryeo.com/_mock/api/aryeo/blocks`,
  {
    method: 'POST',
    headers: {
      'Content-Type': 'application/json',
      Authorization: 'Bearer <YOUR_TOKEN_HERE>'
    },
    body: JSON.stringify({
      company_team_member_ids: [
        '123e4567-e89b-12d3-a456-426614174000'
      ],
      user_ids: [
        '123e4567-e89b-12d3-a456-426614174000'
      ],
      start_at: '2020-10-04T12:15:00Z',
      end_at: '2020-10-04T12:30:00Z',
      title: 'Other appointment',
      description: 'This is a description of the block.'
    })
  }
);

const data = await resp.json();
console.log(data);

Responses

CalendarEventResource

Bodyapplication/json
statusstring[ 0 .. 255 ] charactersrequired

What was the state of the request?

Example: "success"
dataobject(CalendarEvent)

A calendar event.

timestampstring or null(date-time)= 20 characters

The request timestamp (ISO 8601).

Example: "2021-06-30T20:30:00Z"
Response
application/json
{
  "status": "success",
  "data": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "type": "appointment",
    "title": "Other appointment",
    "description": "sdjsudsudsds",
    "start_at": "2020-10-04T12:15:00Z",
    "end_at": "2020-10-04T12:30:00Z",
    "is_all_day": true,
    "duration": 60,
    "is_busy": true,
    "requires_confirmation": true
  },
  "timestamp": "2021-06-30T20:30:00Z"
}

Delete block.

Request

Delete block.

undocumented: false
external: true
Security
Token
Path
block_idstring(uuid)= 36 characters^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[89ab][0...required

The ID of a block. UUID Version 4.

Example: 00000000-0000-4000-8000-000000000000
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>'
    }
  }
);

if (resp.status === 204) {
  console.log('success');
} else {
  const data = await resp.text();
  console.log(data);
}

Responses

No Content

Response
No content

Get block.

Request

Get block.

undocumented: false
external: true
Security
Token
Path
block_idstring(uuid)= 36 characters^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[89ab][0...required

The ID of a block. UUID Version 4.

Example: 00000000-0000-4000-8000-000000000000
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);

Responses

CalendarBlockResource

Bodyapplication/json
statusstring[ 0 .. 255 ] charactersrequired

What was the state of the request?

Example: "success"
dataobject(CalendarBlock)

A calendar block.

timestampstring or null(date-time)= 20 characters

The request timestamp (ISO 8601).

Example: "2021-06-30T20:30:00Z"
Response
application/json
{
  "status": "success",
  "data": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "type": "appointment",
    "title": "Other appointment",
    "description": "sdjsudsudsds",
    "start_at": "2020-10-04T12:15:00Z",
    "end_at": "2020-10-04T12:30:00Z",
    "is_all_day": true,
    "duration": 60,
    "is_busy": true,
    "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,
        "verification_status": "verified",
        "password_expiration_days": 30,
        "timezone": "America/New_York",
        "created_at": "2021-06-30T20:30:00Z"
      }
    ],
    "company_team_members": [
      {
        "object": "COMPANY_TEAM_MEMBER",
        "id": "00000000-0000-4000-8000-000000000000",
        "calendar_color": "#FF0000",
        "permissions": [
          { … }
        ],
        "restrictions": [
          {}
        ],
        "is_service_provider": true,
        "external_id": "1234567890",
        "company_user": {
          "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,
          "verification_status": "verified",
          "password_expiration_days": 30,
          "timezone": "America/New_York",
          "created_at": "2021-06-30T20:30:00Z"
        },
        "has_owner_role": true,
        "is_owner": true,
        "invitation_accepted_at": "2025-04-01T05:59:59.999999Z",
        "role": "ADMIN",
        "status": "active",
        "is_active": true,
        "is_invited": true,
        "is_revoked": true,
        "scheduling_priority": 1,
        "created_at": "2025-04-01T05:59:59.999999Z",
        "require_appointment_confirmation": true,
        "fees": [
          { … }
        ],
        "travel_fee_amount": 1000,
        "travel_fee_is_estimated": true
      }
    ]
  },
  "timestamp": "2021-06-30T20:30:00Z"
}

Update block.

Request

Update block.

undocumented: false
external: true
Security
Token
Path
block_idstring(uuid)= 36 characters^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[89ab][0...required

The ID of a block. UUID Version 4.

Example: 00000000-0000-4000-8000-000000000000
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);

Responses

CalendarEventResource

Bodyapplication/json
statusstring[ 0 .. 255 ] charactersrequired

What was the state of the request?

Example: "success"
dataobject(CalendarEvent)

A calendar event.

timestampstring or null(date-time)= 20 characters

The request timestamp (ISO 8601).

Example: "2021-06-30T20:30:00Z"
Response
application/json
{
  "status": "success",
  "data": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "type": "appointment",
    "title": "Other appointment",
    "description": "sdjsudsudsds",
    "start_at": "2020-10-04T12:15:00Z",
    "end_at": "2020-10-04T12:30:00Z",
    "is_all_day": true,
    "duration": 60,
    "is_busy": true,
    "requires_confirmation": true
  },
  "timestamp": "2021-06-30T20:30:00Z"
}

List regions.

Request

List regions.

undocumented: false
external: true
Security
Token
Query
filter[type]string[ 1 .. 255 ] characters

The type of the region.

Enum"COUNTRY""STATE""COUNTY"
Example: filter[type]=COUNTRY
filter[country_code]string= 2 characters

The country code of the region.

Example: filter[country_code]=US
filter[state_code]string= 2 characters

The state code of the region.

Example: filter[state_code]=CA
per_pagestring[ 1 .. 5 ] characters

The number of items per page. Defaults to 25.

Example: per_page=25
pagestring[ 1 .. 5 ] characters

The requested page. Defaults to 1.

Example: page=2
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);

Responses

RegionCollection

Bodyapplication/json
statusstring[ 0 .. 255 ] characters

What was the state of the request?

Example: "success"
dataArray of objects or null(Region)required

A collection of objects.

data[].​idstring(uuid)= 36 characters^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[89ab][0...required

ID of the entity. UUID Version 4.

Example: "00000000-0000-4000-8000-000000000000"
data[].​typestring[ 1 .. 255 ] charactersrequired

The type of the region.

Enum"COUNTRY""STATE""COUNTY"
Example: "COUNTRY"
data[].​namestring[ 1 .. 255 ] charactersrequired

The name of the region.

Example: "United States"
data[].​descriptionstring or null[ 1 .. 255 ] charactersrequired

The description of the region.

Example: "The United States of America"
data[].​slugstring or null[ 1 .. 255 ] charactersrequired

The slug of the region.

Example: "united-states"
data[].​codestring[ 1 .. 255 ] charactersrequired

The code of the region.

Example: "US"
data[].​country_codestring or null[ 1 .. 255 ] charactersrequired

The country code of the region.

Example: "US"
data[].​state_codestring or null[ 1 .. 255 ] charactersrequired

The state code of the region.

Example: "CA"
metaobject(PaginationMeta)

Metadata about a paginated response.

linksobject(PaginationLinks)

Related links for a paginated response.

timestampstring or null(date-time)= 20 characters

The request timestamp (ISO 8601).

Example: "2021-06-30T20:30:00Z"
Response
application/json
{
  "status": "success",
  "data": [
    {
      "id": "00000000-0000-4000-8000-000000000000",
      "type": "COUNTRY",
      "name": "United States",
      "description": "The United States of America",
      "slug": "united-states",
      "code": "US",
      "country_code": "US",
      "state_code": "CA"
    }
  ],
  "meta": {
    "total": 50,
    "per_page": 15,
    "current_page": 1,
    "last_page": 4,
    "from": 1,
    "to": 15,
    "path": "https://api.aryeo.com/v1/{path}",
    "links": [
      {
        "url": "https://admin.aryeo.test/api/v1/companies?page=2",
        "label": "2",
        "active": true,
        "page": 2
      }
    ]
  },
  "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"
}

Get scheduling assignment.

Request

Get scheduling assignment.

undocumented: false
external: true
Security
Token
Query
order_idstring(uuid)= 36 characters

The ID of an order. UUID Version 4.

Example: order_id=123e4567-e89b-12d3-a456-426614174000
company_team_member_idsArray of strings(uuid)

The IDs of company team members. UUID Version 4.

Example: company_team_member_ids=123e4567-e89b-12d3-a456-426614174000
strategy_typestring[ 0 .. 255 ] characters

The strategy type to use for the scheduling assignment.

Enum"DISTANCE""HOURS_PRIORITY""ROUND_ROBIN""RECOMMENDED""PRIORITY_LIST"
Example: strategy_type=DISTANCE
appointment_datestring(date-time)= 20 characters

The date of the appointment.

Example: appointment_date=2020-01-05T12:00:00Z
appointment_durationinteger[ 1 .. 1440 ]

The duration of the appointment in minutes.

Example: appointment_duration=60
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);

Responses

CompanyTeamMemberResource

Bodyapplication/json
statusstring[ 0 .. 255 ] charactersrequired

What was the state of the request?

Example: "success"
dataobject or null(CompanyTeamMember)

A team member of a company.

timestampstring or null(date-time)= 20 characters

The request timestamp (ISO 8601).

Example: "2021-06-30T20:30:00Z"
strategy_typestring[ 0 .. 255 ] characters

The strategy type to use for assignment scheduling.

Enum"DISTANCE""HOURS_PRIORITY""ROUND_ROBIN""RECOMMENDED""PRIORITY_LIST"
Example: "DISTANCE"
Response
application/json
{
  "status": "success",
  "data": {
    "object": "COMPANY_TEAM_MEMBER",
    "id": "00000000-0000-4000-8000-000000000000",
    "calendar_color": "#FF0000",
    "permissions": [
      {
        "object": "PERMISSION",
        "name": "ACTIVITY_LOG_VIEW"
      }
    ],
    "restrictions": [
      {}
    ],
    "is_service_provider": true,
    "external_id": "1234567890",
    "company_user": {
      "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": [
        {
          "sso_id": "1234",
          "sso_provider": { … }
        }
      ],
      "is_super": true,
      "verification_status": "verified",
      "password_expiration_days": 30,
      "timezone": "America/New_York",
      "created_at": "2021-06-30T20:30:00Z"
    },
    "has_owner_role": true,
    "is_owner": true,
    "invitation_accepted_at": "2025-04-01T05:59:59.999999Z",
    "role": "ADMIN",
    "status": "active",
    "is_active": true,
    "is_invited": true,
    "is_revoked": true,
    "scheduling_priority": 1,
    "created_at": "2025-04-01T05:59:59.999999Z",
    "require_appointment_confirmation": true,
    "fees": [
      {
        "object": "FEE",
        "id": "00000000-0000-4000-8000-000000000000",
        "title": "Flat Fee",
        "type": "FLAT",
        "name": "Flat Fee",
        "description": "Flat fee for the order",
        "avalara_tax_code": "12345",
        "quickbooks_item_id": "12345",
        "amount": 100
      }
    ],
    "travel_fee_amount": 1000,
    "travel_fee_is_estimated": true
  },
  "timestamp": "2021-06-30T20:30:00Z",
  "strategy_type": "DISTANCE"
}

List available dates.

Request

List available dates. Availability can be listed using a specific start & end date range, or using a timeframe. When using a timeframe, the page parameter can be used to flip through weeks, months, etc.

external: true
Security
Token
Query
filter[user_ids][]Array of strings(uuid)

The IDs of users whose availability will be listed. UUID Version 4.

Example: filter[user_ids][]=00000000-0000-4000-8000-000000000000
filter[appointment_id]string= 36 characters^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[89ab][0...

Appointment ID used to list availability for an existing order

Example: filter[appointment_id]=00000000-0000-4000-8000-000000000000
filter[start_at]string(date-time)= 20 characters

Returns availability after start_at

Example: filter[start_at]=2021-01-01T13:00:00Z
filter[end_at]string(date-time)= 20 characters

Returns availability before end_at

Example: filter[end_at]=2021-01-02T13:00:00Z
filter[timeframe]string[ 1 .. 5 ] characters

Returns availability for a specific timeframe. Used instead of start_at & end_at

Enum"DAY""WEEK""MONTH""YEAR"
Example: filter[timeframe]=MONTH
durationinteger[ 1 .. 360 ]

Duration of the event to schedule. Required if appointment_id isn't specified

Example: duration=60
intervalinteger[ 1 .. 360 ]

Interval of bookable timeslots starting at x minutes on the hour . Required if appointment_id isn't specified

Example: interval=15
timezonestring[ 3 .. 50 ] charactersrequired

The timezone of the client. Available dates results will be localized to this timezone

Example: timezone=CST
pageinteger>= 1

The requested page of results. Use this parameter to flip through pages when using the timeframe filter

Example: page=1
per_pageinteger

The number of results per page. Only applies when using a date range

Example: per_page=5
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);

Responses

CalendarDayCollection

Bodyapplication/json
statusstring[ 0 .. 255 ] charactersrequired

What was the state of the request?

Example: "success"
dataArray of objects or null(CalendarDay)

A collection of objects.

metaobject(CalendarDayCollectionMeta)

Metadata about a calendar day paginated response.

linksobject(PaginationLinks)

Related links for a paginated response.

timestampstring or null(date-time)= 20 characters

The request timestamp (ISO 8601).

Example: "2021-06-30T20:30:00Z"
Response
application/json
{
  "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,
        "page": 2
      }
    ],
    "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"
}

List available timeslots.

Request

List available timeslots. Timeslots are returned for the entire day in the local timezone.

Results are returned in UTC!

external: true
Security
Token
Query
filter[user_ids][]Array of strings(uuid)

The IDs of users whose appointments will be listed. UUID Version 4.

Example: filter[user_ids][]=00000000-0000-4000-8000-000000000000
filter[appointment_id]string= 36 characters^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[89ab][0...

Appointment ID used to list availability for an existing order

Example: filter[appointment_id]=00000000-0000-4000-8000-000000000000
durationinteger[ 1 .. 360 ]

Duration of the event to schedule. Required if appointment_id isn't specified

Example: duration=60
intervalinteger[ 1 .. 360 ]

Interval of bookable timeslots starting at x minutes on the hour . Required if appointment_id isn't specified

Example: interval=25
pageinteger>= 1

The requested page of results

Example: page=1
per_pageinteger>= 1

The number of results per page. Only applies when using a date range

Example: per_page=5
datestring(date)= 10 charactersrequired

The date to list available timeslots

Example: date=2021-01-01
timezonestring[ 3 .. 50 ] charactersrequired

The timezone is used to determine the start and end time of the specified date to list a full day of results.

Example: timezone=CST
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);

Responses

TimeslotCollection

Bodyapplication/json
statusstring[ 0 .. 255 ] charactersrequired

What was the state of the request?

Example: "success"
dataArray of objects or null(Timeslot)

A collection of objects.

metaobject(CalendarDayCollectionMeta)

Metadata about a calendar day paginated response.

linksobject(PaginationLinks)

Related links for a paginated response.

timestampstring or null(date-time)= 20 characters

The request timestamp (ISO 8601).

Example: "2021-06-30T20:30:00Z"
Response
application/json
{
  "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,
          "verification_status": "verified",
          "password_expiration_days": 30,
          "timezone": "America/New_York",
          "created_at": "2021-06-30T20:30:00Z"
        }
      ]
    }
  ],
  "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,
        "page": 2
      }
    ],
    "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"
}

List schedule item groupings.

Request

List schedule item groupings.

undocumented: false
external: true
Security
Token
Query
item_idsArray of strings(uuid)required

The IDs of the items to group.

Example: item_ids=123e4567-e89b-12d3-a456-426614174000
appointment_idstring(uuid)= 36 characters

The ID of the appointment to group.

Example: appointment_id=123e4567-e89b-12d3-a456-426614174000
const query = new URLSearchParams({
  item_ids: '123e4567-e89b-12d3-a456-426614174000'
}).toString();

const resp = await fetch(
  `https://docs.aryeo.com/_mock/api/aryeo/scheduling/item-groupings?${query}`,
  {
    method: 'GET',
    headers: {
      Authorization: 'Bearer <YOUR_TOKEN_HERE>'
    }
  }
);

const data = await resp.text();
console.log(data);

Responses

OrderItemGroupingCollection

Bodyapplication/json
statusstring[ 0 .. 255 ] characters

What was the state of the request?

Example: "success"
dataArray of objects or null(OrderItemGrouping)required

A collection of objects.

data[].​objectstring or null[ 0 .. 10 ] characters

A canonical value representing a resource.

Example: "ORDER_ITEM_GROUPING"
data[].​usersArray of objects or null(User)required

Users attached to the grouping.

data[].​users[].​objectstring or null[ 0 .. 255 ] characters

A canonical value representing a resource.

Example: "PERSONAL_ACCESS_TOKEN"
data[].​users[].​idstring(uuid)= 36 characters^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[89ab][0...required

ID of the entity. UUID Version 4.

Example: "00000000-0000-4000-8000-000000000000"
data[].​users[].​emailstring(email)[ 0 .. 255 ] charactersrequired

Email address of the user.

Example: "john.doe@gmail.com"
data[].​users[].​first_namestring or null[ 0 .. 255 ] characters

First name of the user.

Example: "John"
data[].​users[].​last_namestring or null[ 0 .. 255 ] characters

Last name of the user.

Example: "Doe"
data[].​users[].​full_namestring or null[ 0 .. 255 ] characters

The full name of the user.

Example: "John Doe"
data[].​users[].​internal_notesstring or null[ 0 .. 65535 ] characters

Internal notes for the user.

Example: "Internal notes for the user."
data[].​users[].​statusstring[ 0 .. 255 ] characters

The status of the user.

Enum"active""inactive""new""sso"
Example: "active"
data[].​users[].​phonestring or null[ 0 .. 255 ] characters

A phone number represented in whichever standards specified by the user, typically ###-###-#### (separated by hyphens).

Example: "123456789"
data[].​users[].​avatar_urlstring or null(uri)[ 0 .. 255 ] characters

The avatar image URL of a user.

Example: "https://picsum.photos/300"
data[].​users[].​relationshipstring or null[ 0 .. 255 ] characters

Describes user's relationship (access level) to a specified group. Only returned if this resource is returned as a sub-resource of a group.

Example: "owner"
data[].​users[].​sso_usersArray of objects(SsoUser)

The list of SSO users associated with this user.

data[].​users[].​is_superboolean or null

Indicates if the user is a super user.

Example: true
data[].​users[].​verification_statusstring[ 0 .. 255 ] characters

The verification status of the user.

Enum"verified""unverified""new""sso"
Example: "verified"
data[].​users[].​password_expiration_daysinteger or null

The number of days until the user's password expires.

Example: 30
data[].​users[].​timezonestring or null[ 0 .. 255 ] characters

The default timezone for the user.

Example: "America/New_York"
data[].​users[].​created_atstring or null(date-time)= 20 characters

The date and time (ISO 8601 format) when the user was created.

Example: "2021-06-30T20:30:00Z"
data[].​company_team_membersArray of objects or null(CompanyTeamMember)required

Company team members attached to the grouping.

data[].​company_team_members[].​objectstring= 19 charactersrequired

A canonical value representing a resource.

Value"COMPANY_TEAM_MEMBER"
Example: "COMPANY_TEAM_MEMBER"
data[].​company_team_members[].​idstring(uuid)= 36 characters^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[89ab][0...required

ID of the entity. UUID Version 4.

Example: "00000000-0000-4000-8000-000000000000"
data[].​company_team_members[].​calendar_colorstring or null= 7 characters

Color code for calendar display, if assigned

Example: "#FF0000"
data[].​company_team_members[].​permissionsArray of objects(CompanyTeamMemberPermission)required

List of permissions granted to the team member

data[].​company_team_members[].​permissions[].​objectstring= 10 characters

A canonical value representing a resource.

Value"PERMISSION"
Example: "PERMISSION"
data[].​company_team_members[].​permissions[].​namestring[ 0 .. 255 ] charactersrequired

The name of the permission

Enum"ACTIVITY_LOG_VIEW""APP_STORE_VIEW_ANY""APPOINTMENTS_MANAGE""AVAILABILITY_VIEW_ANY""CALENDAR_VIEW_ANY""CUSTOMER_CREATE""CUSTOMER_DELETE""CUSTOMER_EXPORT_CREATE""CUSTOMER_IMPORT_CREATE""CUSTOMER_VIEW_ANY"
Example: "ACTIVITY_LOG_VIEW"
data[].​company_team_members[].​restrictionsArray of objectsrequired

List of restrictions applied to the team member

object

A key-value pair of restriction data.

data[].​company_team_members[].​is_service_providerbooleanrequired

Indicates if the team member is a service provider

Example: true
data[].​company_team_members[].​external_idstring or null[ 0 .. 65536 ] characters

External identifier for the team member, if any

Example: "1234567890"
data[].​company_team_members[].​company_userobject or null(User)

A record of a person on the Aryeo platform.

data[].​company_team_members[].​has_owner_roleboolean or null

Indicates if the team member has the owner role

Example: true
data[].​company_team_members[].​is_ownerboolean or null

Indicates if the team member is the owner

Example: true
data[].​company_team_members[].​invitation_accepted_atstring or null(date-time)= 27 characters

The date and time (ISO 8601 format) when the company team member invitation was accepted

Example: "2025-04-01T05:59:59.999999Z"
data[].​company_team_members[].​rolestring or null

The role of the team member

Enum"ADMIN""MEMBER""OWNER"
Example: "ADMIN"
data[].​company_team_members[].​statusstring or null

The status of the team member

Enum"active""invited""revoked"
Example: "active"
data[].​company_team_members[].​is_activeboolean or null

Indicates if the team member is active

Example: true
data[].​company_team_members[].​is_invitedboolean or null

Indicates if the team member is invited

Example: true
data[].​company_team_members[].​is_revokedboolean or null

Indicates if the team member is revoked

Example: true
data[].​company_team_members[].​scheduling_priorityinteger or null

The scheduling priority of the team member

Example: 1
data[].​company_team_members[].​created_atstring or null(date-time)= 27 characters

The date and time (ISO 8601 format) when the company team member was created

Example: "2025-04-01T05:59:59.999999Z"
data[].​company_team_members[].​require_appointment_confirmationboolean or null

Indicates if the team member requires appointment confirmation

Example: true
data[].​company_team_members[].​feesArray of objects(Fee)

The fees assigned to the team member

data[].​company_team_members[].​travel_fee_amountinteger or null

The travel fee amount in cents

Example: 1000
data[].​company_team_members[].​travel_fee_is_estimatedboolean or null

Indicates if the travel fee is estimated

Example: true
data[].​productsArray of objects(Product)required

Products attached to the grouping.

data[].​products[].​objectstring= 7 characters

A canonical value representing a resource.

Value"PRODUCT"
Example: "PRODUCT"
data[].​products[].​idstring(uuid)= 36 characters^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[89ab][0...required

ID of the entity. UUID Version 4.

Example: "00000000-0000-4000-8000-000000000000"
data[].​products[].​titlestring[ 0 .. 255 ] charactersrequired

The title of the product.

Example: "House photos"
data[].​products[].​descriptionstring[ 0 .. 65536 ] characters

The description of the product.

Example: "Capture photos of a house for sale."
data[].​products[].​activeboolean

The active status of a product.

Example: true
data[].​products[].​typestring[ 0 .. 255 ] charactersrequired

The type of product.

Enum"MAIN""ADDON"
Example: "MAIN"
data[].​products[].​is_twilightboolean

Whether the product is available during twilight hours.

Example: true
data[].​products[].​image_urlstring or null(uri)[ 0 .. 65536 ] characters

A URL for an example property image.

Example: "https://picsum.photos/400/200"
data[].​products[].​is_serviceableboolean

Whether the product is serviceable.

Example: true
data[].​products[].​requires_separate_bookingboolean

Whether the product requires a separate booking.

Example: true
data[].​products[].​always_display_addonsboolean

Whether to always display addons for the product.

Example: true
data[].​products[].​variant_filter_typestring or null[ 0 .. 255 ] characters

The type of variant filter.

Example: "ALL"
data[].​products[].​avalara_tax_codestring or null[ 0 .. 255 ] characters

The Avalara tax code for the product.

Example: "12345"
data[].​products[].​limit_quantity_amountinteger or null

The limit quantity amount for the product.

Example: 10
data[].​products[].​limit_quantityboolean

Whether the product has a limit quantity.

Example: true
data[].​products[].​is_filterableboolean

Whether the product is filterable.

Example: true
data[].​products[].​is_esoft_adjustmentboolean

Whether the product is an eSoft adjustment.

Example: true
data[].​products[].​variantsArray of objects(ProductVariant)
data[].​products[].​categoriesArray of objects(ProductCategory)
data[].​products[].​tagsArray of objects(ProductCategory)
data[].​itemsArray of objects(OrderItem)required

Order items attached to the grouping.

data[].​items[].​objectstring= 10 characters

A canonical value representing a resource.

Value"ORDER_ITEM"
Example: "ORDER_ITEM"
data[].​items[].​idstring(uuid)= 36 characters^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[89ab][0...required

ID of the entity. UUID Version 4.

Example: "00000000-0000-4000-8000-000000000000"
data[].​items[].​titlestring[ 0 .. 255 ] characters

The title of the item.

Example: "Aerial Video"
data[].​items[].​subtitlestring[ 0 .. 255 ] characters

The sub title of the item.

Example: "10 minute video"
data[].​items[].​sub_titlestring[ 0 .. 255 ] characters

The sub title of the item.

Example: "10 minute video"
data[].​items[].​descriptionstring[ 0 .. 255 ] characters

The description of the item.

Example: "A fly-by drone video of the property."
data[].​items[].​purchasable_typestring[ 0 .. 255 ] characters

The type of order item.

Enum"PRODUCT_VARIANT""FEE""CUSTOM"
Example: "FEE"
data[].​items[].​amountinteger>= 0

A positive integer in the smallest currency unit (that is, 100 cents for $1.00) representing the cost of a single instance of this item. This is multiplied by the quantity to calculate what was or will be charged. Legacy version of unit_price_amount.

Example: 2099
data[].​items[].​unit_price_amountinteger>= 0

A positive integer in the smallest currency unit (that is, 100 cents for $1.00) representing the cost of a single instance of this item. This is multiplied by the quantity to calculate what was or will be charged.

Example: 2099
data[].​items[].​quantityinteger>= 0

A positive integer representing the number of instances of this item that was or will be serviced.

Example: 2
data[].​items[].​gross_total_amountinteger>= 0

A positive integer in the smallest currency unit (that is, 100 cents for $1.00) representing the total cost of this item (before discounts and taxes have been applied) to be charge.

Example: 4198
data[].​items[].​appointmentobject(Appointment)

An appointment.

data[].​items[].​discountsArray of objects(DiscountAmount)
data[].​items[].​orderobject(Order)

A payment request for some content or service.

data[].​items[].​productobject(Product)

A product available for purchase via an order.

data[].​items[].​product_variantobject(ProductVariant)

A variant of a product.

data[].​items[].​taxesArray of objects(Tax)
data[].​items[].​is_serviceableboolean

Whether the order item is serviceable.

Example: true
data[].​items[].​tasksArray of objects(Task)

The tasks associated with the order item.

data[].​items[].​is_canceledboolean

Whether the order item is canceled.

Example: true
data[].​durationinteger[ 1 .. 1440 ]required

The duration of the grouping in minutes.

Example: 60
metaobject(PaginationMeta)

Metadata about a paginated response.

linksobject(PaginationLinks)

Related links for a paginated response.

timestampstring or null(date-time)= 20 characters

The request timestamp (ISO 8601).

Example: "2021-06-30T20:30:00Z"
Response
application/json
{
  "status": "success",
  "data": [
    {
      "object": "ORDER_ITEM_GROUPING",
      "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,
          "verification_status": "verified",
          "password_expiration_days": 30,
          "timezone": "America/New_York",
          "created_at": "2021-06-30T20:30:00Z"
        }
      ],
      "company_team_members": [
        {
          "object": "COMPANY_TEAM_MEMBER",
          "id": "00000000-0000-4000-8000-000000000000",
          "calendar_color": "#FF0000",
          "permissions": [ … ],
          "restrictions": [ … ],
          "is_service_provider": true,
          "external_id": "1234567890",
          "company_user": { … },
          "has_owner_role": true,
          "is_owner": true,
          "invitation_accepted_at": "2025-04-01T05:59:59.999999Z",
          "role": "ADMIN",
          "status": "active",
          "is_active": true,
          "is_invited": true,
          "is_revoked": true,
          "scheduling_priority": 1,
          "created_at": "2025-04-01T05:59:59.999999Z",
          "require_appointment_confirmation": true,
          "fees": [ … ],
          "travel_fee_amount": 1000,
          "travel_fee_is_estimated": true
        }
      ],
      "products": [
        {
          "object": "PRODUCT",
          "id": "00000000-0000-4000-8000-000000000000",
          "title": "House photos",
          "description": "Capture photos of a house for sale.",
          "active": true,
          "type": "MAIN",
          "is_twilight": true,
          "image_url": "https://picsum.photos/400/200",
          "is_serviceable": true,
          "requires_separate_booking": true,
          "always_display_addons": true,
          "variant_filter_type": "ALL",
          "avalara_tax_code": "12345",
          "limit_quantity_amount": 10,
          "limit_quantity": true,
          "is_filterable": true,
          "is_esoft_adjustment": true,
          "variants": [ … ],
          "categories": [ … ],
          "tags": [ … ]
        }
      ],
      "items": [
        {
          "object": "ORDER_ITEM",
          "id": "00000000-0000-4000-8000-000000000000",
          "title": "Aerial Video",
          "subtitle": "10 minute video",
          "sub_title": "10 minute video",
          "description": "A fly-by drone video of the property.",
          "purchasable_type": "FEE",
          "amount": 2099,
          "unit_price_amount": 2099,
          "quantity": 2,
          "gross_total_amount": 4198,
          "appointment": { … },
          "discounts": [ … ],
          "order": { … },
          "product": { … },
          "product_variant": { … },
          "taxes": [ … ],
          "is_serviceable": true,
          "tasks": [ … ],
          "is_canceled": true
        }
      ],
      "duration": 60
    }
  ],
  "meta": {
    "total": 50,
    "per_page": 15,
    "current_page": 1,
    "last_page": 4,
    "from": 1,
    "to": 15,
    "path": "https://api.aryeo.com/v1/{path}",
    "links": [
      {
        "url": "https://admin.aryeo.test/api/v1/companies?page=2",
        "label": "2",
        "active": true,
        "page": 2
      }
    ]
  },
  "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"
}

Tags

Operations related to tags. Tags are used to organize and categorize content using a flexible tagging system.

Operations

Tasks

Operations related to tasks. Tasks are used to track work items, assignments, and completion status.

Operations

Videos

Operations related to videos.

Operations