Skip to content
/Company Users

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

List company team members.

Request

List company team members.

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

Return company team members with a match on the search term.

Example: filter[search]=Brendan
filter[ids]string[ 1 .. 255 ] characters

Return company team members with a match on the search term.

Example: filter[ids]=00000000-0000-4000-8000-000000000000,00000000-0000-4000-8000-000000000001
includestring[ 0 .. 255 ] characters

Comma separated list of optional data to include in the response.

Example: include=company
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/company-team-members`,
  {
    method: 'GET',
    headers: {
      Authorization: 'Bearer <YOUR_TOKEN_HERE>'
    }
  }
);

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

Responses

CompanyTeamMemberCollection

Bodyapplication/json
statusstring[ 0 .. 255 ] charactersrequired

What was the state of the request?

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

A collection of objects.

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": "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": [
          { … }
        ],
        "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
    }
  ],
  "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 company team member.

Request

Get company team member.

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

The ID of a company team member. UUID Version 4.

Example: 00000000-0000-4000-8000-000000000000
Query
includestring[ 0 .. 255 ] characters

Comma separated list of optional data to include in the response.

Example: include=company
const companyTeamMemberId = '00000000-0000-4000-8000-000000000000';
const resp = await fetch(
  `https://docs.aryeo.com/_mock/api/aryeo/company-team-members/${companyTeamMemberId}`,
  {
    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(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"
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
  },
  "timestamp": "2021-06-30T20:30:00Z"
}

List company team member events.

Request

List company team member events.

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

The ID of a company team member. UUID Version 4.

Example: 00000000-0000-4000-8000-000000000000
Query
startstring(date-time)= 20 characters

The start date and time of the calendar events. ISO 8601 format.

Example: start=2020-12-29T00:00:00-00:00
endstring(date-time)= 20 characters

The end date and time of the calendar events. ISO 8601 format.

Example: end=2020-12-31T00:00:00-00:00
typestring[ 0 .. 255 ] characters

The type of the calendar events.

Enum"APPOINTMENT""CALENDAR_BLOCK""EXTERNAL""BUFFER""DECLINED_APPOINTMENT""UNSCHEDULED_APPOINTMENT"
Example: type=APPOINTMENT
include_unscheduledboolean

Include unscheduled appointments.

Example: include_unscheduled=true
const companyTeamMemberId = '00000000-0000-4000-8000-000000000000';
const resp = await fetch(
  `https://docs.aryeo.com/_mock/api/aryeo/company-team-members/${companyTeamMemberId}/events`,
  {
    method: 'GET',
    headers: {
      Authorization: 'Bearer <YOUR_TOKEN_HERE>'
    }
  }
);

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

Responses

CalendarEventCollection

Bodyapplication/json
statusstring[ 0 .. 255 ] charactersrequired

What was the state of the request?

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

A collection of objects.

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": "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
    }
  ],
  "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"
}

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

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