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

Users

Operations related to users.

Operations

List company team members.

Request

List company team members.

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

200

Bodyapplication/json
object
Response
application/json
{}

Get company team member.

Request

Get company team member.

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

200

Bodyapplication/json
object
Response
application/json
{}

List company team member events.

Request

List company team member events.

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

200

Bodyapplication/json
object
Response
application/json
{}

Get customer team member.

Request

Get customer team member.

undocumented: true
external: true
Path
customer_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 customer team member. UUID Version 4.

Example: 00000000-0000-4000-8000-000000000000
const customerTeamMemberId = '00000000-0000-4000-8000-000000000000';
const resp = await fetch(
  `https://docs.aryeo.com/_mock/api/aryeo/customer-team-members/${customerTeamMemberId}`,
  {
    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 customer team memberships.

Request

List customer team memberships.

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

The ID of a customer team. UUID Version 4.

Example: 00000000-0000-4000-8000-000000000000
const customerTeamId = '00000000-0000-4000-8000-000000000000';
const resp = await fetch(
  `https://docs.aryeo.com/_mock/api/aryeo/customer-teams/${customerTeamId}/memberships`,
  {
    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 customer team affiliate membership.

Request

Create customer team affiliate membership.

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

Request

List customer users.

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

Request

Create customer user.

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

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

Responses

200

Bodyapplication/json
object
Response
application/json
{}

Store customer user credit transaction.

Request

Store customer user credit transaction.

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

The ID of a user. UUID Version 4.

Example: 00000000-0000-4000-8000-000000000000
Bodyapplication/jsonrequired
typestring[ 5 .. 6 ] charactersrequired

The type of transaction

Enum"credit""debit"
Example: "credit"
amountinteger>= 1required

The amount in cents

Example: 100
descriptionstring[ 0 .. 255 ] characters

Optional description of the transaction

Example: "Description of transaction"
datestring(date)= 10 characters

The date for the transaction in UTC (YYYY-MM-DD)

Example: "2025-01-01"
const user = '00000000-0000-4000-8000-000000000000';
const resp = await fetch(
  `https://docs.aryeo.com/_mock/api/aryeo/customer-users/${user}/credit-transactions`,
  {
    method: 'POST',
    headers: {
      'Content-Type': 'application/json',
      Authorization: 'Bearer <YOUR_TOKEN_HERE>'
    },
    body: JSON.stringify({
      type: 'credit',
      amount: 100,
      description: 'Description of transaction',
      date: '2025-01-01'
    })
  }
);

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

Responses

Credit transaction created successfully

Bodyapplication/json
typestring[ 5 .. 6 ] charactersrequired

The type of credit transaction

Enum"credit""debit"
Example: "credit"
amountinteger>= 1required

The amount in cents

Example: 1
descriptionstring or null[ 0 .. 255 ] characters

Optional description of the transaction

Example: "Transaction description"
user_idstring(uuid)= 36 characters^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[89ab][0...required

ID of the user associated with the transaction. UUID Version 4.

Example: "00000000-0000-4000-8000-000000000000"
posting_datestring or null(date)

The date the transaction was posted (YYYY-MM-DD)

Example: "2025-01-01"
created_atstring(date-time)= 20 charactersrequired

The date and time the transaction was created

Example: "2025-01-01T20:30:00Z"
updated_atstring(date-time)= 20 charactersrequired

The date and time the transaction was updated

Example: "2025-01-01T20:30:00Z"
Response
application/json
{ "type": "credit", "amount": 1, "description": "Transaction description", "user_id": "00000000-0000-4000-8000-000000000000", "posting_date": "2025-01-01", "created_at": "2025-01-01T20:30:00Z", "updated_at": "2025-01-01T20:30:00Z" }

List customers.

Request

List customers.

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

Request

Create a customer.

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

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

Responses

201

Bodyapplication/json
object
Response
application/json
{}

Videos

Operations related to videos.

Operations