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

Products

Operations related to products.

Operations

Scheduling

Operations related to scheduling.

Operations

Tags

Operations related to tags.

Operations

Tasks

Operations related to tasks.

Operations

List commands.

Request

List commands.

undocumented: true
external: true
const resp = await fetch(
  `https://docs.aryeo.com/_mock/api/aryeo/command-palette/commands`,
  {
    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 tasks.

Request

List tasks.

undocumented: true
external: true
const resp = await fetch(
  `https://docs.aryeo.com/_mock/api/aryeo/tasks`,
  {
    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 task.

Request

Create task.

undocumented: true
external: true
const resp = await fetch(
  `https://docs.aryeo.com/_mock/api/aryeo/tasks`,
  {
    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 task.

Request

Delete task.

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

The ID of a task. UUID Version 4.

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

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

Responses

200

Bodyapplication/json
object
Response
application/json
{}

Get task.

Request

Get task.

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

The ID of a task. UUID Version 4.

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

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

Responses

200

Bodyapplication/json
object
Response
application/json
{}

Update task.

Request

Update task.

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

The ID of a task. UUID Version 4.

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

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

Responses

200

Bodyapplication/json
object
Response
application/json
{}

Complete task.

Request

Complete task.

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

The ID of a task. UUID Version 4.

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

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

Responses

200

Bodyapplication/json
object
Response
application/json
{}

Reinstate task.

Request

Reinstate task.

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

The ID of a task. UUID Version 4.

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

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

Responses

200

Bodyapplication/json
object
Response
application/json
{}

Users

Operations related to users.

Operations

Videos

Operations related to videos.

Operations