Skip to content
/Tasks

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

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

List tasks.

Request

List tasks.

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

TaskCollection

Bodyapplication/json
statusstring[ 0 .. 255 ] charactersrequired

What was the state of the request?

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

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": "00000000-0000-4000-8000-000000000000",
      "name": "Complete 41 Drone Shots, Variant corporis",
      "description": "Complete 41 Drone Shots, Variant corporis",
      "quantity": 1,
      "pay_run_item_amount": 10000,
      "due_at": "2021-06-30T20:30:00Z",
      "completed_at": "2021-06-30T20:30:00Z",
      "is_completed": true,
      "completed_by": {
        "object": "COMPANY_TEAM_MEMBER",
        "id": "00000000-0000-4000-8000-000000000000",
        "calendar_color": "#FF0000",
        "permissions": [
          { … }
        ],
        "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,
        "fees": [
          { … }
        ],
        "travel_fee_amount": 1000,
        "travel_fee_is_estimated": true
      },
      "assignee": {
        "object": "COMPANY_TEAM_MEMBER",
        "id": "00000000-0000-4000-8000-000000000000",
        "calendar_color": "#FF0000",
        "permissions": [
          { … }
        ],
        "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,
        "fees": [
          { … }
        ],
        "travel_fee_amount": 1000,
        "travel_fee_is_estimated": true
      },
      "task_template": {
        "id": "00000000-0000-4000-8000-000000000000",
        "name": "Complete 41 Drone Shots, Variant corporis",
        "description": "Complete 41 Drone Shots, Variant corporis",
        "product_variant": {
          "object": "PRODUCT_VARIANT",
          "id": "00000000-0000-4000-8000-000000000000",
          "title": "House photos",
          "price": 10000,
          "price_amount": 10000,
          "base_price_amount": 10000,
          "base_is_hidden": true,
          "display_original_price": true,
          "duration": 60
        },
        "default_pay_run_item_amount": 10000,
        "default_pay_run_item_amount_type": "flat",
        "pay_run_item_amount_overrides": [
          { … }
        ]
      }
    }
  ],
  "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"
}

Create task.

Request

Create task.

undocumented: false
external: true
Security
Token
Bodyapplication/json
namestring[ 0 .. 255 ] charactersrequired

The name of the task.

Example: "Complete 41 Drone Shots, Variant corporis"
descriptionstring or null[ 0 .. 65536 ] characters

The description of the task.

Example: "Complete 41 Drone Shots, Variant corporis"
due_atstring or null(date-time)= 20 characters

The due date of the task.

Example: "2021-06-30T20:30:00Z"
completed_atstring or null(date-time)= 20 characters

The completed date of the task.

Example: "2021-06-30T20:30:00Z"
company_team_member_idstring or null(uuid)= 36 characters

The ID of the company team member assigned to the task.

Example: "123e4567-e89b-12d3-a456-426614174000"
const resp = await fetch(
  `https://docs.aryeo.com/_mock/api/aryeo/tasks`,
  {
    method: 'POST',
    headers: {
      'Content-Type': 'application/json',
      Authorization: 'Bearer <YOUR_TOKEN_HERE>'
    },
    body: JSON.stringify({
      name: 'Complete 41 Drone Shots, Variant corporis',
      description: 'Complete 41 Drone Shots, Variant corporis',
      due_at: '2021-06-30T20:30:00Z',
      completed_at: '2021-06-30T20:30:00Z',
      company_team_member_id: '123e4567-e89b-12d3-a456-426614174000'
    })
  }
);

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

Responses

TaskResource

Bodyapplication/json
statusstring[ 0 .. 255 ] charactersrequired

What was the state of the request?

Example: "success"
dataobject(Task)

A task is a single unit of work that can be assigned to a user.

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": "00000000-0000-4000-8000-000000000000",
    "name": "Complete 41 Drone Shots, Variant corporis",
    "description": "Complete 41 Drone Shots, Variant corporis",
    "quantity": 1,
    "pay_run_item_amount": 10000,
    "due_at": "2021-06-30T20:30:00Z",
    "completed_at": "2021-06-30T20:30:00Z",
    "is_completed": true,
    "completed_by": {
      "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,
      "fees": [
        {
          "object": "FEE",
          "id": "00000000-0000-4000-8000-000000000000",
          "title": "Flat Fee",
          "type": "FLAT",
          "name": "Flat Fee",
          "description": "Flat fee for the order",
          "avalara_tax_code": "12345",
          "quickbooks_item_id": "12345",
          "amount": 100
        }
      ],
      "travel_fee_amount": 1000,
      "travel_fee_is_estimated": true
    },
    "assignee": {
      "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,
      "fees": [
        {
          "object": "FEE",
          "id": "00000000-0000-4000-8000-000000000000",
          "title": "Flat Fee",
          "type": "FLAT",
          "name": "Flat Fee",
          "description": "Flat fee for the order",
          "avalara_tax_code": "12345",
          "quickbooks_item_id": "12345",
          "amount": 100
        }
      ],
      "travel_fee_amount": 1000,
      "travel_fee_is_estimated": true
    },
    "task_template": {
      "id": "00000000-0000-4000-8000-000000000000",
      "name": "Complete 41 Drone Shots, Variant corporis",
      "description": "Complete 41 Drone Shots, Variant corporis",
      "product_variant": {
        "object": "PRODUCT_VARIANT",
        "id": "00000000-0000-4000-8000-000000000000",
        "title": "House photos",
        "price": 10000,
        "price_amount": 10000,
        "base_price_amount": 10000,
        "base_is_hidden": true,
        "display_original_price": true,
        "duration": 60
      },
      "default_pay_run_item_amount": 10000,
      "default_pay_run_item_amount_type": "flat",
      "pay_run_item_amount_overrides": [
        {
          "id": "00000000-0000-4000-8000-000000000000",
          "task_template": {},
          "amount": 10000,
          "amount_type": "flat"
        }
      ]
    }
  },
  "timestamp": "2021-06-30T20:30:00Z"
}

Delete task.

Request

Delete task.

undocumented: false
external: true
Security
Token
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>'
    }
  }
);

if (resp.status === 204) {
  console.log('success');
} else {
  const data = await resp.text();
  console.log(data);
}

Responses

No Content

Response
No content

Get task.

Request

Get task.

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

TaskResource

Bodyapplication/json
statusstring[ 0 .. 255 ] charactersrequired

What was the state of the request?

Example: "success"
dataobject(Task)

A task is a single unit of work that can be assigned to a user.

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": "00000000-0000-4000-8000-000000000000",
    "name": "Complete 41 Drone Shots, Variant corporis",
    "description": "Complete 41 Drone Shots, Variant corporis",
    "quantity": 1,
    "pay_run_item_amount": 10000,
    "due_at": "2021-06-30T20:30:00Z",
    "completed_at": "2021-06-30T20:30:00Z",
    "is_completed": true,
    "completed_by": {
      "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,
      "fees": [
        {
          "object": "FEE",
          "id": "00000000-0000-4000-8000-000000000000",
          "title": "Flat Fee",
          "type": "FLAT",
          "name": "Flat Fee",
          "description": "Flat fee for the order",
          "avalara_tax_code": "12345",
          "quickbooks_item_id": "12345",
          "amount": 100
        }
      ],
      "travel_fee_amount": 1000,
      "travel_fee_is_estimated": true
    },
    "assignee": {
      "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,
      "fees": [
        {
          "object": "FEE",
          "id": "00000000-0000-4000-8000-000000000000",
          "title": "Flat Fee",
          "type": "FLAT",
          "name": "Flat Fee",
          "description": "Flat fee for the order",
          "avalara_tax_code": "12345",
          "quickbooks_item_id": "12345",
          "amount": 100
        }
      ],
      "travel_fee_amount": 1000,
      "travel_fee_is_estimated": true
    },
    "task_template": {
      "id": "00000000-0000-4000-8000-000000000000",
      "name": "Complete 41 Drone Shots, Variant corporis",
      "description": "Complete 41 Drone Shots, Variant corporis",
      "product_variant": {
        "object": "PRODUCT_VARIANT",
        "id": "00000000-0000-4000-8000-000000000000",
        "title": "House photos",
        "price": 10000,
        "price_amount": 10000,
        "base_price_amount": 10000,
        "base_is_hidden": true,
        "display_original_price": true,
        "duration": 60
      },
      "default_pay_run_item_amount": 10000,
      "default_pay_run_item_amount_type": "flat",
      "pay_run_item_amount_overrides": [
        {
          "id": "00000000-0000-4000-8000-000000000000",
          "task_template": {},
          "amount": 10000,
          "amount_type": "flat"
        }
      ]
    }
  },
  "timestamp": "2021-06-30T20:30:00Z"
}

Update task.

Request

Update task.

undocumented: false
external: true
Security
Token
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
Bodyapplication/json
namestring[ 0 .. 255 ] charactersrequired

The name of the task.

Example: "Complete 41 Drone Shots, Variant corporis"
descriptionstring or null[ 0 .. 65536 ] characters

The description of the task.

Example: "Complete 41 Drone Shots, Variant corporis"
due_atstring or null(date-time)= 20 characters

The due date of the task.

Example: "2021-06-30T20:30:00Z"
completed_atstring or null(date-time)= 20 characters

The completed date of the task.

Example: "2021-06-30T20:30:00Z"
company_team_member_idstring or null(uuid)= 36 characters

The ID of the company team member assigned to the task.

Example: "123e4567-e89b-12d3-a456-426614174000"
const taskId = '00000000-0000-4000-8000-000000000000';
const resp = await fetch(
  `https://docs.aryeo.com/_mock/api/aryeo/tasks/${taskId}`,
  {
    method: 'PUT',
    headers: {
      'Content-Type': 'application/json',
      Authorization: 'Bearer <YOUR_TOKEN_HERE>'
    },
    body: JSON.stringify({
      name: 'Complete 41 Drone Shots, Variant corporis',
      description: 'Complete 41 Drone Shots, Variant corporis',
      due_at: '2021-06-30T20:30:00Z',
      completed_at: '2021-06-30T20:30:00Z',
      company_team_member_id: '123e4567-e89b-12d3-a456-426614174000'
    })
  }
);

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

Responses

TaskResource

Bodyapplication/json
statusstring[ 0 .. 255 ] charactersrequired

What was the state of the request?

Example: "success"
dataobject(Task)

A task is a single unit of work that can be assigned to a user.

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": "00000000-0000-4000-8000-000000000000",
    "name": "Complete 41 Drone Shots, Variant corporis",
    "description": "Complete 41 Drone Shots, Variant corporis",
    "quantity": 1,
    "pay_run_item_amount": 10000,
    "due_at": "2021-06-30T20:30:00Z",
    "completed_at": "2021-06-30T20:30:00Z",
    "is_completed": true,
    "completed_by": {
      "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,
      "fees": [
        {
          "object": "FEE",
          "id": "00000000-0000-4000-8000-000000000000",
          "title": "Flat Fee",
          "type": "FLAT",
          "name": "Flat Fee",
          "description": "Flat fee for the order",
          "avalara_tax_code": "12345",
          "quickbooks_item_id": "12345",
          "amount": 100
        }
      ],
      "travel_fee_amount": 1000,
      "travel_fee_is_estimated": true
    },
    "assignee": {
      "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,
      "fees": [
        {
          "object": "FEE",
          "id": "00000000-0000-4000-8000-000000000000",
          "title": "Flat Fee",
          "type": "FLAT",
          "name": "Flat Fee",
          "description": "Flat fee for the order",
          "avalara_tax_code": "12345",
          "quickbooks_item_id": "12345",
          "amount": 100
        }
      ],
      "travel_fee_amount": 1000,
      "travel_fee_is_estimated": true
    },
    "task_template": {
      "id": "00000000-0000-4000-8000-000000000000",
      "name": "Complete 41 Drone Shots, Variant corporis",
      "description": "Complete 41 Drone Shots, Variant corporis",
      "product_variant": {
        "object": "PRODUCT_VARIANT",
        "id": "00000000-0000-4000-8000-000000000000",
        "title": "House photos",
        "price": 10000,
        "price_amount": 10000,
        "base_price_amount": 10000,
        "base_is_hidden": true,
        "display_original_price": true,
        "duration": 60
      },
      "default_pay_run_item_amount": 10000,
      "default_pay_run_item_amount_type": "flat",
      "pay_run_item_amount_overrides": [
        {
          "id": "00000000-0000-4000-8000-000000000000",
          "task_template": {},
          "amount": 10000,
          "amount_type": "flat"
        }
      ]
    }
  },
  "timestamp": "2021-06-30T20:30:00Z"
}

Complete task.

Request

Complete task.

undocumented: false
external: true
Security
Token
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
Bodyapplication/json
completed_atstring or null(date-time)= 20 charactersrequired

The completed date of the task.

Example: "2021-06-30T20:30:00Z"
const taskId = '00000000-0000-4000-8000-000000000000';
const resp = await fetch(
  `https://docs.aryeo.com/_mock/api/aryeo/tasks/${taskId}/complete`,
  {
    method: 'PUT',
    headers: {
      'Content-Type': 'application/json',
      Authorization: 'Bearer <YOUR_TOKEN_HERE>'
    },
    body: JSON.stringify({
      completed_at: '2021-06-30T20:30:00Z'
    })
  }
);

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

Responses

TaskResource

Bodyapplication/json
statusstring[ 0 .. 255 ] charactersrequired

What was the state of the request?

Example: "success"
dataobject(Task)

A task is a single unit of work that can be assigned to a user.

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": "00000000-0000-4000-8000-000000000000",
    "name": "Complete 41 Drone Shots, Variant corporis",
    "description": "Complete 41 Drone Shots, Variant corporis",
    "quantity": 1,
    "pay_run_item_amount": 10000,
    "due_at": "2021-06-30T20:30:00Z",
    "completed_at": "2021-06-30T20:30:00Z",
    "is_completed": true,
    "completed_by": {
      "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,
      "fees": [
        {
          "object": "FEE",
          "id": "00000000-0000-4000-8000-000000000000",
          "title": "Flat Fee",
          "type": "FLAT",
          "name": "Flat Fee",
          "description": "Flat fee for the order",
          "avalara_tax_code": "12345",
          "quickbooks_item_id": "12345",
          "amount": 100
        }
      ],
      "travel_fee_amount": 1000,
      "travel_fee_is_estimated": true
    },
    "assignee": {
      "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,
      "fees": [
        {
          "object": "FEE",
          "id": "00000000-0000-4000-8000-000000000000",
          "title": "Flat Fee",
          "type": "FLAT",
          "name": "Flat Fee",
          "description": "Flat fee for the order",
          "avalara_tax_code": "12345",
          "quickbooks_item_id": "12345",
          "amount": 100
        }
      ],
      "travel_fee_amount": 1000,
      "travel_fee_is_estimated": true
    },
    "task_template": {
      "id": "00000000-0000-4000-8000-000000000000",
      "name": "Complete 41 Drone Shots, Variant corporis",
      "description": "Complete 41 Drone Shots, Variant corporis",
      "product_variant": {
        "object": "PRODUCT_VARIANT",
        "id": "00000000-0000-4000-8000-000000000000",
        "title": "House photos",
        "price": 10000,
        "price_amount": 10000,
        "base_price_amount": 10000,
        "base_is_hidden": true,
        "display_original_price": true,
        "duration": 60
      },
      "default_pay_run_item_amount": 10000,
      "default_pay_run_item_amount_type": "flat",
      "pay_run_item_amount_overrides": [
        {
          "id": "00000000-0000-4000-8000-000000000000",
          "task_template": {},
          "amount": 10000,
          "amount_type": "flat"
        }
      ]
    }
  },
  "timestamp": "2021-06-30T20:30:00Z"
}

Reinstate task.

Request

Reinstate task.

undocumented: false
external: true
Security
Token
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
Bodyapplication/json
object(TaskReinstatePutPayload)

Payload for reinstating a task.

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

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

Responses

TaskResource

Bodyapplication/json
statusstring[ 0 .. 255 ] charactersrequired

What was the state of the request?

Example: "success"
dataobject(Task)

A task is a single unit of work that can be assigned to a user.

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": "00000000-0000-4000-8000-000000000000",
    "name": "Complete 41 Drone Shots, Variant corporis",
    "description": "Complete 41 Drone Shots, Variant corporis",
    "quantity": 1,
    "pay_run_item_amount": 10000,
    "due_at": "2021-06-30T20:30:00Z",
    "completed_at": "2021-06-30T20:30:00Z",
    "is_completed": true,
    "completed_by": {
      "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,
      "fees": [
        {
          "object": "FEE",
          "id": "00000000-0000-4000-8000-000000000000",
          "title": "Flat Fee",
          "type": "FLAT",
          "name": "Flat Fee",
          "description": "Flat fee for the order",
          "avalara_tax_code": "12345",
          "quickbooks_item_id": "12345",
          "amount": 100
        }
      ],
      "travel_fee_amount": 1000,
      "travel_fee_is_estimated": true
    },
    "assignee": {
      "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,
      "fees": [
        {
          "object": "FEE",
          "id": "00000000-0000-4000-8000-000000000000",
          "title": "Flat Fee",
          "type": "FLAT",
          "name": "Flat Fee",
          "description": "Flat fee for the order",
          "avalara_tax_code": "12345",
          "quickbooks_item_id": "12345",
          "amount": 100
        }
      ],
      "travel_fee_amount": 1000,
      "travel_fee_is_estimated": true
    },
    "task_template": {
      "id": "00000000-0000-4000-8000-000000000000",
      "name": "Complete 41 Drone Shots, Variant corporis",
      "description": "Complete 41 Drone Shots, Variant corporis",
      "product_variant": {
        "object": "PRODUCT_VARIANT",
        "id": "00000000-0000-4000-8000-000000000000",
        "title": "House photos",
        "price": 10000,
        "price_amount": 10000,
        "base_price_amount": 10000,
        "base_is_hidden": true,
        "display_original_price": true,
        "duration": 60
      },
      "default_pay_run_item_amount": 10000,
      "default_pay_run_item_amount_type": "flat",
      "pay_run_item_amount_overrides": [
        {
          "id": "00000000-0000-4000-8000-000000000000",
          "task_template": {},
          "amount": 10000,
          "amount_type": "flat"
        }
      ]
    }
  },
  "timestamp": "2021-06-30T20:30:00Z"
}

Videos

Operations related to videos.

Operations