Skip to content
/Payroll

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

Create billing setup intent.

Request

Create billing setup intent.

undocumented: false
external: true
Security
Token
const resp = await fetch(
  `https://docs.aryeo.com/_mock/api/aryeo/billing/setup-intents`,
  {
    method: 'POST',
    headers: {
      Authorization: 'Bearer <YOUR_TOKEN_HERE>'
    }
  }
);

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

Responses

SetupIntentResponse

Bodyapplication/json
client_secretstring or null[ 1 .. 255 ] charactersrequired

The client secret for the SetupIntent.

Example: "abc-123"
Response
application/json
{
  "client_secret": "abc-123"
}

List order item pay run item defaults.

Request

List order item pay run item defaults.

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

The ID of an order item. UUID Version 4.

Example: 00000000-0000-4000-8000-000000000000
const orderItemId = '00000000-0000-4000-8000-000000000000';
const resp = await fetch(
  `https://docs.aryeo.com/_mock/api/aryeo/order-items/${orderItemId}/pay-run-item-defaults`,
  {
    method: 'GET',
    headers: {
      Authorization: 'Bearer <YOUR_TOKEN_HERE>'
    }
  }
);

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

Responses

OrderItemPayRunItemDefaults

Bodyapplication/json
order_item_idstring(uuid)= 36 characters^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[89ab][0...required

The ID of the order item. UUID Version 4.

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

The title of the pay run item.

Example: "Complete Photography"
company_team_memberobject(CompanyTeamMember)required

A team member of a company.

company_team_member.​objectstring= 19 charactersrequired

A canonical value representing a resource.

Value"COMPANY_TEAM_MEMBER"
Example: "COMPANY_TEAM_MEMBER"
company_team_member.​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"
company_team_member.​calendar_colorstring or null= 7 characters

Color code for calendar display, if assigned

Example: "#FF0000"
company_team_member.​permissionsArray of objects(CompanyTeamMemberPermission)required

List of permissions granted to the team member

company_team_member.​permissions[].​objectstring= 10 characters

A canonical value representing a resource.

Value"PERMISSION"
Example: "PERMISSION"
company_team_member.​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"
company_team_member.​restrictionsArray of objectsrequired

List of restrictions applied to the team member

object

A key-value pair of restriction data.

company_team_member.​is_service_providerbooleanrequired

Indicates if the team member is a service provider

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

External identifier for the team member, if any

Example: "1234567890"
company_team_member.​company_userobject or null(User)

A record of a person on the Aryeo platform.

company_team_member.​has_owner_roleboolean or null

Indicates if the team member has the owner role

Example: true
company_team_member.​is_ownerboolean or null

Indicates if the team member is the owner

Example: true
company_team_member.​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"
company_team_member.​rolestring or null

The role of the team member

Enum"ADMIN""MEMBER""OWNER"
Example: "ADMIN"
company_team_member.​statusstring or null

The status of the team member

Enum"active""invited""revoked"
Example: "active"
company_team_member.​is_activeboolean or null

Indicates if the team member is active

Example: true
company_team_member.​is_invitedboolean or null

Indicates if the team member is invited

Example: true
company_team_member.​is_revokedboolean or null

Indicates if the team member is revoked

Example: true
company_team_member.​scheduling_priorityinteger or null

The scheduling priority of the team member

Example: 1
company_team_member.​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"
company_team_member.​require_appointment_confirmationboolean or null

Indicates if the team member requires appointment confirmation

Example: true
amountnumberrequired

The amount of the pay run item.

Example: 100
Response
application/json
{
  "order_item_id": "00000000-0000-4000-8000-000000000000",
  "title": "Complete Photography",
  "company_team_member": {
    "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
  },
  "amount": 100
}

List payroll pay run items.

Request

List payroll pay run items.

undocumented: true
external: true
Security
Token
const resp = await fetch(
  `https://docs.aryeo.com/_mock/api/aryeo/payroll/pay-run-items`,
  {
    method: 'GET',
    headers: {
      Authorization: 'Bearer <YOUR_TOKEN_HERE>'
    }
  }
);

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

Responses

200

Bodyapplication/json
object
Response
application/json
{}

Create payroll pay run item.

Request

Create payroll pay run item.

undocumented: true
external: true
Security
Token
const resp = await fetch(
  `https://docs.aryeo.com/_mock/api/aryeo/payroll/pay-run-items`,
  {
    method: 'POST',
    headers: {
      Authorization: 'Bearer <YOUR_TOKEN_HERE>'
    }
  }
);

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

Responses

201

Bodyapplication/json
object
Response
application/json
{}

Delete payroll pay run item.

Request

Delete payroll pay run item.

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

The ID of a pay run item. UUID Version 4.

Example: 00000000-0000-4000-8000-000000000000
const payRunItem = '00000000-0000-4000-8000-000000000000';
const resp = await fetch(
  `https://docs.aryeo.com/_mock/api/aryeo/payroll/pay-run-items/${payRunItem}`,
  {
    method: 'DELETE',
    headers: {
      Authorization: 'Bearer <YOUR_TOKEN_HERE>'
    }
  }
);

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

Responses

200

Bodyapplication/json
object
Response
application/json
{}

Update payroll pay run item.

Request

Update payroll pay run item.

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

The ID of a pay run item. UUID Version 4.

Example: 00000000-0000-4000-8000-000000000000
const payRunItem = '00000000-0000-4000-8000-000000000000';
const resp = await fetch(
  `https://docs.aryeo.com/_mock/api/aryeo/payroll/pay-run-items/${payRunItem}`,
  {
    method: 'PUT',
    headers: {
      Authorization: 'Bearer <YOUR_TOKEN_HERE>'
    }
  }
);

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

Responses

200

Bodyapplication/json
object
Response
application/json
{}

Add pay run item to pay run.

Request

Add pay run item to pay run.

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

The ID of a pay run. UUID Version 4.

Example: 00000000-0000-4000-8000-000000000000
const payRun = '00000000-0000-4000-8000-000000000000';
const resp = await fetch(
  `https://docs.aryeo.com/_mock/api/aryeo/payroll/pay-runs/${payRun}/items/add`,
  {
    method: 'POST',
    headers: {
      Authorization: 'Bearer <YOUR_TOKEN_HERE>'
    }
  }
);

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

Responses

201

Bodyapplication/json
object
Response
application/json
{}

Remove pay run item from pay run.

Request

Remove pay run item from pay run.

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

The ID of a pay run. UUID Version 4.

Example: 00000000-0000-4000-8000-000000000000
const payRun = '00000000-0000-4000-8000-000000000000';
const resp = await fetch(
  `https://docs.aryeo.com/_mock/api/aryeo/payroll/pay-runs/${payRun}/items/remove`,
  {
    method: 'POST',
    headers: {
      Authorization: 'Bearer <YOUR_TOKEN_HERE>'
    }
  }
);

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

Responses

201

Bodyapplication/json
object
Response
application/json
{}

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