The Aryeo API provides access to the Aryeo platform.

Languages
Servers
Mock server

https://docs.aryeo.com/_mock/api/aryeo/

Production

https://api.aryeo.com/v1/

Addresses

Operations related to addresses.

Operations

Appointments

Operations related to appointments.

Operations

Discounts

Operations related to discounts.

Operations

Listings

Operations related to listings.

Operations

Notes

Operations related to notes.

Operations

Order Forms

Operations related to order forms.

Operations

Order Items

Operations related to order items.

Operations

Orders

Operations related to orders.

Operations

Payroll

Operations related to payroll.

Operations

Create billing setup intent.

Request

Create billing setup intent.

undocumented: true
external: true
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

201

Bodyapplication/json
object
Response
application/json
{}

List order item pay run item defaults.

Request

List order item pay run item defaults.

undocumented: true
external: true
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

200

Bodyapplication/json
object
Response
application/json
{}

List payroll pay run items.

Request

List payroll pay run items.

undocumented: true
external: true
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
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
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
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
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
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.

Operations

Scheduling

Operations related to scheduling.

Operations

Tags

Operations related to tags.

Operations

Tasks

Operations related to tasks.

Operations

Users

Operations related to users.

Operations

Videos

Operations related to videos.

Operations