Skip to content
API Reference
/
/
List customer team member...

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

Get customer team member.

Request

Get customer team member.

undocumented: true
external: true
Security
Token
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
Security
Token
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
Security
Token
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: false
external: true
Security
Token
Query
includestring[ 0 .. 255 ] characters

Comma separated list of optional data to include in the response.

Example: include=users
filter[exclude_customers_in_team]string[ 0 .. 255 ] characters

Filter customers by customer team ID.

Example: filter[exclude_customers_in_team]=00000000-0000-4000-8000-000000000000
filter[exclude_customers_in_pricing_plan]string[ 0 .. 255 ] characters

Filter customers by pricing plan ID.

Example: filter[exclude_customers_in_pricing_plan]=00000000-0000-4000-8000-000000000000
filter[exclude_customers_with_individual_pricing_plan]boolean

Filter customers that do not have an individual pricing plan.

Example: filter[exclude_customers_with_individual_pricing_plan]=true
filter[exclude_customers_with_team_pricing_plan]boolean

Filter customers that do not have a team pricing plan.

Example: filter[exclude_customers_with_team_pricing_plan]=true
filter[customer_team_ids]string[ 0 .. 255 ] characters

Comma separated list of customer team IDs.

Example: filter[customer_team_ids]=00000000-0000-4000-8000-000000000000
filter[has_active_team_memberships]boolean

Filter customers that have active team memberships.

Example: filter[has_active_team_memberships]=true
filter[search]string[ 0 .. 255 ] characters

Filter customers by search.

Example: filter[search]=john
sortstring[ 1 .. 100 ] characters

Comma separated list of fields used for sorting. Placing a minus symbol in front of a field name sorts in descending order. Defaults to -created_at.

Example: sort=-created_at
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

CustomerUserCollection

Bodyapplication/json
dataArray of objects or null(CustomerUser)required

A collection of objects.

data[].​objectstring or null[ 0 .. 255 ] characters

A canonical value representing a resource.

Example: "USER"
data[].​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"
data[].​namestring or null[ 0 .. 255 ] characters

Name of the user.

Example: "John"
data[].​emailstring(email)[ 0 .. 255 ] charactersrequired

Email address of the user.

Example: "john.doe@gmail.com"
data[].​avatar_urlstring or null(uri)[ 0 .. 255 ] characters

The avatar image URL of a user.

Example: "https://picsum.photos/300"
data[].​phonestring or null[ 0 .. 255 ] characters

A phone number represented in whichever standards specified by the user, typically ###-###-#### (separated by hyphens).

Example: "123456789"
data[].​logo_urlstring or null(uri)[ 0 .. 255 ] characters

The logo URL of a user.

Example: "https://picsum.photos/300"
data[].​timezonestring or null[ 0 .. 255 ] characters

The default timezone for the customer.

Example: "America/New_York"
data[].​license_numberstring or null[ 0 .. 255 ] characters

The license number of a real estate agent. Only returned if group's type is AGENT.

Example: "12345678"
data[].​customer_team_membershipsArray of objects(CustomerTeamMembership)
data[].​created_atstring(date-time)= 20 characters

The date and time (ISO 8601 format) when the customer record was created.

Example: "2021-06-30T20:30:00Z"
data[].​is_visibleboolean or null

Indicates if the customer is visible.

Example: true
data[].​order_indexinteger or null

The order index of the customer.

Example: 1
data[].​verification_statusstring[ 0 .. 255 ] characters

The verification status of the customer.

Enum"verified""unverified""new""sso"
Example: "verified"
data[].​credit_balance_amountnumber or null

The credit balance amount of the customer.

Example: 100
data[].​total_balance_amountnumber or null

The total balance amount of the customer.

Example: 100
data[].​is_showingtimeplus_userboolean

Whether the customer is a ShowingTime+ user.

Example: true
data[].​full_namestring[ 0 .. 255 ] characters

The full name of the customer.

Example: "John Doe"
data[].​first_namestring[ 0 .. 255 ] characters

The first name of the customer.

Example: "John"
data[].​last_namestring[ 0 .. 255 ] characters

The last name of the customer.

Example: "Doe"
data[].​phone_numberstring or null[ 0 .. 255 ] characters

The phone number of the customer.

Example: "1234567890"
data[].​profile_linkstring or null[ 0 .. 255 ] characters

The profile link of the customer.

Example: "https://picsum.photos/300"
data[].​internal_notesstring or null[ 0 .. 2550 ] characters

The internal notes of the customer.

Example: "John Doe is a customer."
data[].​agent_company_namestring or null[ 0 .. 255 ] characters

The agent company name of the customer.

Example: "John Doe Real Estate"
data[].​agent_license_numberstring or null[ 0 .. 255 ] characters

The agent license number of the customer.

Example: "1234567890"
data[].​is_blocked_from_orderingboolean

Whether the customer is blocked from ordering.

Example: true
data[].​has_restricted_photographersboolean

Whether the customer is restricted from booking appointments with certain photographers.

Example: true
data[].​default_lock_downloads_before_paymentboolean or null

Whether the customer has locked media downloads before payment as the default download setting.

Example: true
data[].​default_allows_access_to_marketing_materialboolean or null

Whether the customer has access to the marketing material builder.

Example: true
data[].​avalara_customer_codestring or null[ 0 .. 255 ] characters

The Avalara customer code of the customer.

Example: "1234567890"
data[].​quickbooks_customer_idstring or null[ 0 .. 255 ] characters

The Quickbooks customer ID of the customer.

Example: "1234567890"
metaobject(PaginationMeta)
linksobject(PaginationLinks)
timestampstring or null(date-time)= 20 characters

The request timestamp (ISO 8601).

Example: "2021-06-30T20:30:00Z"
Response
application/json
{
  "data": [
    {
      "object": "USER",
      "id": "00000000-0000-4000-8000-000000000000",
      "name": "John",
      "email": "john.doe@gmail.com",
      "avatar_url": "https://picsum.photos/300",
      "phone": "123456789",
      "logo_url": "https://picsum.photos/300",
      "timezone": "America/New_York",
      "license_number": "12345678",
      "customer_team_memberships": [
        {
          "object": "CUSTOMER_TEAM_MEMBERSHIP",
          "id": "00000000-0000-4000-8000-000000000000",
          "role": "admin",
          "invitation_accepted_at": "2025-04-01T05:59:59.999999Z",
          "status": "active",
          "customer_team": { … },
          "is_active": true,
          "is_archived": true,
          "is_deleted": true,
          "is_invited": true,
          "is_default": true,
          "created_at": "2025-04-01T05:59:59.999999Z",
          "customer_user": {},
          "listing_delivery_notification_enabled": true,
          "is_showingtimeplus_workspace_membership": true,
          "is_visible": true,
          "order_index": 1
        }
      ],
      "created_at": "2021-06-30T20:30:00Z",
      "is_visible": true,
      "order_index": 1,
      "verification_status": "verified",
      "credit_balance_amount": 100,
      "total_balance_amount": 100,
      "is_showingtimeplus_user": true,
      "full_name": "John Doe",
      "first_name": "John",
      "last_name": "Doe",
      "phone_number": "1234567890",
      "profile_link": "https://picsum.photos/300",
      "internal_notes": "John Doe is a customer.",
      "agent_company_name": "John Doe Real Estate",
      "agent_license_number": "1234567890",
      "is_blocked_from_ordering": true,
      "has_restricted_photographers": true,
      "default_lock_downloads_before_payment": true,
      "default_allows_access_to_marketing_material": true,
      "avalara_customer_code": "1234567890",
      "quickbooks_customer_id": "1234567890"
    }
  ],
  "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 customer user.

Request

Create customer user.

undocumented: false
external: true
Security
Token
Bodyapplication/json

CustomerUserPostPayload

first_namestring[ 0 .. 255 ] charactersrequired

First name.

Example: "John"
last_namestring[ 0 .. 255 ] charactersrequired

Last name.

Example: "Doe"
emailstring[ 0 .. 255 ] charactersrequired

Email address of the user.

Example: "john.doe@gmail.com"
phonestring or null[ 0 .. 255 ] characters

A phone number represented in whichever standards specified by the user, typically ###-###-#### (separated by hyphens).

Example: "(123) 456-7890"
license_numberstring or null[ 0 .. 255 ] characters

The license number of a real estate agent.

Example: "12345678"
avatar_urlstring or null(uri)[ 0 .. 255 ] characters

The avatar image URL of a user.

Example: "https://picsum.photos/300"
add_to_customer_teambooleanrequired

Whether to add the user to a customer team.

Example: true
customer_team_idstring[ 0 .. 255 ] characters

The ID of the customer team to add the user to. Required if add_to_customer_team is true.

Example: "123e4567-e89b-12d3-a456-426614174000"
rolestring[ 0 .. 255 ] characters

The role of the user in the customer team. Required if add_to_customer_team is true.

Enum"admin""member"
Example: "admin"
defines_new_teamboolean or null

Whether to define a new team for the user. Required if add_to_customer_team is false.

Example: true
namestring or null[ 0 .. 255 ] characters

The name of the new team. Required if defines_new_team is true.

Example: "John Doe Reality"
descriptionstring or null[ 0 .. 2550 ] characters

The description of the new team. Used if defines_new_team is true.

Example: "Internal notes about the team."
brokerage_namestring or null[ 0 .. 255 ] characters

The name of the brokerage. Used if defines_new_team is true.

Example: "John Doe Realty"
timezonestring or null[ 0 .. 255 ] characters

The default timezone for the customer.

Example: "America/New_York"
const resp = await fetch(
  `https://docs.aryeo.com/_mock/api/aryeo/customer-users`,
  {
    method: 'POST',
    headers: {
      'Content-Type': 'application/json',
      Authorization: 'Bearer <YOUR_TOKEN_HERE>'
    },
    body: JSON.stringify({
      first_name: 'John',
      last_name: 'Doe',
      email: 'john.doe@gmail.com',
      phone: '(123) 456-7890',
      license_number: '12345678',
      avatar_url: 'https://picsum.photos/300',
      add_to_customer_team: true,
      customer_team_id: '123e4567-e89b-12d3-a456-426614174000',
      role: 'admin',
      defines_new_team: true,
      name: 'John Doe Reality',
      description: 'Internal notes about the team.',
      brokerage_name: 'John Doe Realty',
      timezone: 'America/New_York'
    })
  }
);

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

Responses

GroupCustomer

Bodyapplication/json
objectstring[ 1 .. 100 ] characters

String representing the object's type. Objects of the same type share the same schema.

Example: "GROUP"
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"
typestring[ 0 .. 255 ] characters

The type of the group. Can be CREATOR, AGENT, or BROKERAGE, and may dictate the attributes of the group returned.

Enum"CREATOR""AGENT""BROKERAGE"
Example: "AGENT"
namestring[ 0 .. 255 ] characters

The name of the group.

Example: "John Doe Reality"
emailstring or null(email)[ 0 .. 255 ] characters

The email address of a group.

Example: "john.doe@gmail.com"
phonestring or null[ 0 .. 255 ] characters

A phone number represented in whichever standards specified by the group, typically ###-###-#### (separated by hyphens).

Example: "6175550173"
website_urlstring or null(uri)[ 0 .. 255 ] characters

The website URL of a group.

Example: "https://www.aryeo.com"
logo_urlstring or null(uri)[ 0 .. 255 ] characters

The logo URL of a group.

Example: "https://picsum.photos/300"
office_namestring or null[ 0 .. 255 ] characters

The name of the brokerage or team of a real estate agent. Only returned if group's type is AGENT.

Example: "John Doe Brokerage"
license_numberstring or null[ 0 .. 255 ] characters

The license number of a real estate agent. Only returned if group's type is AGENT.

Example: "12345678"
timezonestring or null[ 0 .. 255 ] characters

The default timezone for the group.

Example: "America/New_York"
currencystring[ 0 .. 255 ] characters

The default currency for the group.

Enum"USD""CAD""GBP""CHF""EUR""AUD""NZD""ZAR""DKK"
Example: "USD"
slugstring or null[ 0 .. 255 ] characters

The slug for the group.

Example: "example-photography"
order_page_urlstring or null[ 0 .. 255 ] characters

The order page URL for the group.

Example: "https://example-photography.aryeo.com/order"
feature_flagsArray of strings or null

An array of feature flags for the group.

Enum"alternate_unbranded_property_site_url""avalara_tax_syncing""avalara_taxes""byop""calendar""calendar_event_title_modified""customer_teams_order_form_landing_page_override""customer_teams_product_preselect""customer_portal_mobile_apps""customer_select_on_order_form_products_step"
Example: ["require_photographer_confirmations"]
order_page_background_colorstring or null= 7 characters

The background color for the order page (has a hex value) for the group.

Example: "#FF0000"
default_order_formobject(OrderForm)
use_territory_awarenessboolean or null

Indicates if the order form by default uses territories to filter available users and products.

Example: true
availability_stylestring or null[ 0 .. 255 ] characters

The scheduling style the order form should use for timeslot selection by default.

Enum"TIME""TIME_OF_DAY""LEGACY"
Example: "TIME"
slot_interval_minutesinteger or null

How frequently slotted available times are on the order form by default.

Example: 60
use_automated_user_assignmentboolean or null

Indicates if the order form uses auto-assignment of users to appointments.

Example: true
automated_user_assignment_strategystring or null[ 0 .. 255 ] characters

The default assignment strategy the order form should use to assign users to appointments, if applicable.

Enum"RECOMMENDED""HOURS_PRIORITY""DISTANCE""ROUND_ROBIN""PRIORITY_LIST"
Example: "RECOMMENDED"
show_user_namesboolean or null

Indicates if the order form by default should display user's names after they have been assigned to an appointment.

Example: true
use_instant_appointment_schedulingboolean or null

Indicates if the order form by default instantly schedules appointments as soon as the order is placed.

Example: true
order_formsArray of objects or null(OrderForm)

An array of order forms a vendor group provides for placing orders. Only returned if group's type is CREATOR.

usersArray of objects or null or null(User)

The Aryeo users associated with this group.

is_brokerage_or_brokerage_agentboolean or null

Indicates if the group is a brokerage or brokerage agent.

Example: true
avatar_urlstring or null(uri)[ 0 .. 255 ] characters

The avatar image URL of a user.

Example: "https://picsum.photos/300"
internal_notesstring or null[ 0 .. 2550 ] characters

Internal notes about the group.

Example: "Internal notes about the group."
team_membersArray of objects or null or null(User)

NOTE: Users do not have team members.

ownerobject or null(User)
social_profilesobject or null(SocialProfiles)
customer_groupstring or null[ 0 .. 2550 ] characters

NOTE: Users do not have customer groups and they are deprecated.

Example: "null"
has_restricted_photographersboolean or null

Whether the group is restricted from booking appointments with certain photographers.

Example: true
custom_field_entriesArray of objects or null

NOTE: Need to make a migration plan for this.

billing_addressstring or null[ 0 .. 255 ] characters

The billing address of the group.

Example: "123 Main St, Anytown, USA 12345"
created_atstring or null(date-time)= 20 characters

The date and time the group was created.

Example: "2021-06-30T20:30:00Z"
restricted_photographersArray of objects or null

The photographers restricted from the group.

customer_team_membershipsArray of objects(CustomerTeamMembership)

The list of customer team memberships associated with this group.

is_visibleboolean or null

Indicates if the group is visible.

Example: true
order_indexinteger or null

The order index of the group.

Example: 1
verification_statusstring[ 0 .. 255 ] characters

The verification status of the customer.

Enum"verified""unverified""new""sso"
Example: "verified"
credit_balance_amountnumber or null

The credit balance amount of the customer.

Example: 100
total_balance_amountnumber or null

The total balance amount of the customer.

Example: 100
is_showingtimeplus_userboolean

Whether the customer is a ShowingTime+ user.

Example: true
full_namestring[ 0 .. 255 ] characters

The full name of the customer.

Example: "John Doe"
first_namestring[ 0 .. 255 ] characters

The first name of the customer.

Example: "John"
last_namestring[ 0 .. 255 ] characters

The last name of the customer.

Example: "Doe"
phone_numberstring or null[ 0 .. 255 ] characters

The phone number of the customer.

Example: "1234567890"
profile_linkstring or null[ 0 .. 255 ] characters

The profile link of the customer.

Example: "https://picsum.photos/300"
agent_company_namestring or null[ 0 .. 255 ] characters

The agent company name of the customer.

Example: "John Doe Real Estate"
agent_license_numberstring or null[ 0 .. 255 ] characters

The agent license number of the customer.

Example: "1234567890"
is_blocked_from_orderingboolean

Whether the customer is blocked from ordering.

Example: true
default_lock_downloads_before_paymentboolean or null

Whether the customer has locked media downloads before payment as the default download setting.

Example: true
default_allows_access_to_marketing_materialboolean or null

Whether the customer has access to the marketing material builder.

Example: true
avalara_customer_codestring or null[ 0 .. 255 ] characters

The Avalara customer code of the customer.

Example: "1234567890"
quickbooks_customer_idstring or null[ 0 .. 255 ] characters

The Quickbooks customer ID of the customer.

Example: "1234567890"
Response
application/json
{
  "object": "GROUP",
  "id": "00000000-0000-4000-8000-000000000000",
  "type": "AGENT",
  "name": "John Doe Reality",
  "email": "john.doe@gmail.com",
  "phone": "6175550173",
  "website_url": "https://www.aryeo.com",
  "logo_url": "https://picsum.photos/300",
  "office_name": "John Doe Brokerage",
  "license_number": "12345678",
  "timezone": "America/New_York",
  "currency": "USD",
  "slug": "example-photography",
  "order_page_url": "https://example-photography.aryeo.com/order",
  "feature_flags": [
    "require_photographer_confirmations"
  ],
  "order_page_background_color": "#FF0000",
  "default_order_form": {
    "object": "ORDER_FORM",
    "id": "00000000-0000-4000-8000-000000000000",
    "title": "BQ's Photography Order Form",
    "type": "ARYEO",
    "url": "https://www.aryeo.com/order-forms/00000000-0000-4000-8000-000000000000",
    "is_public": true,
    "thumbnail_url": "https://picsum.photos/300",
    "use_territory_awareness": true,
    "availability_style": "TIME",
    "slot_interval_minutes": 60,
    "use_automated_user_assignment": true,
    "automated_user_assignment_strategy": "RECOMMENDED",
    "show_user_names": true,
    "require_upfront_payment": true,
    "upfront_payment_percentage": 50,
    "use_instant_appointment_scheduling": true,
    "form_settings": {},
    "owner": {
      "object": "GROUP",
      "id": "00000000-0000-4000-8000-000000000000",
      "type": "AGENT",
      "name": "John Doe Reality",
      "email": "john.doe@gmail.com",
      "phone": "6175550173",
      "website_url": "https://www.aryeo.com",
      "logo_url": "https://picsum.photos/300",
      "office_name": "John Doe Brokerage",
      "license_number": "12345678",
      "timezone": "America/New_York",
      "currency": "USD",
      "slug": "example-photography",
      "order_page_url": "https://example-photography.aryeo.com/order",
      "feature_flags": [
        "require_photographer_confirmations"
      ],
      "order_page_background_color": "#FF0000",
      "social_profiles": {
        "facebook_profile_url": "https://www.facebook.com/johndoe",
        "instagram_profile_url": "https://www.instagram.com/johndoe",
        "twitter_profile_url": "https://twitter.com/johndoe",
        "linkedin_profile_url": "https://www.linkedin.com/in/johndoe/",
        "zillow_profile_url": "https://www.zillow.com/profile/johndoe"
      },
      "default_order_form": {},
      "use_territory_awareness": true,
      "availability_style": "TIME",
      "slot_interval_minutes": 60,
      "use_automated_user_assignment": true,
      "automated_user_assignment_strategy": "RECOMMENDED",
      "show_user_names": true,
      "use_instant_appointment_scheduling": true,
      "allow_order_cancellation": true,
      "order_forms": [
        {}
      ],
      "owner": {
        "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
      },
      "users": [
        {
          "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
        }
      ],
      "is_brokerage_or_brokerage_agent": true,
      "avatar_url": "https://picsum.photos/300",
      "internal_notes": "Internal notes about the group.",
      "team_members": [
        {
          "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
        }
      ],
      "customer_group": "null",
      "custom_field_entries": [
        {}
      ],
      "created_at": "2021-06-30T20:30:00Z",
      "has_restricted_photographers": true,
      "is_payroll_enabled": true,
      "is_visible": true,
      "order_index": 1
    },
    "company": {
      "object": "GROUP",
      "id": "00000000-0000-4000-8000-000000000000",
      "type": "AGENT",
      "name": "John Doe Reality",
      "email": "john.doe@gmail.com",
      "phone": "6175550173",
      "website_url": "https://www.aryeo.com",
      "logo_url": "https://picsum.photos/300",
      "office_name": "John Doe Brokerage",
      "license_number": "12345678",
      "timezone": "America/New_York",
      "currency": "USD",
      "slug": "example-photography",
      "order_page_url": "https://example-photography.aryeo.com/order",
      "feature_flags": [
        "require_photographer_confirmations"
      ],
      "order_page_background_color": "#FF0000",
      "social_profiles": {
        "facebook_profile_url": "https://www.facebook.com/johndoe",
        "instagram_profile_url": "https://www.instagram.com/johndoe",
        "twitter_profile_url": "https://twitter.com/johndoe",
        "linkedin_profile_url": "https://www.linkedin.com/in/johndoe/",
        "zillow_profile_url": "https://www.zillow.com/profile/johndoe"
      },
      "default_order_form": {},
      "use_territory_awareness": true,
      "availability_style": "TIME",
      "slot_interval_minutes": 60,
      "use_automated_user_assignment": true,
      "automated_user_assignment_strategy": "RECOMMENDED",
      "show_user_names": true,
      "use_instant_appointment_scheduling": true,
      "allow_order_cancellation": true,
      "order_forms": [
        {}
      ],
      "owner": {
        "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
      },
      "users": [
        {
          "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
        }
      ],
      "is_brokerage_or_brokerage_agent": true,
      "avatar_url": "https://picsum.photos/300",
      "internal_notes": "Internal notes about the group.",
      "team_members": [
        {
          "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
        }
      ],
      "customer_group": "null",
      "custom_field_entries": [
        {}
      ],
      "created_at": "2021-06-30T20:30:00Z",
      "has_restricted_photographers": true,
      "is_payroll_enabled": true,
      "is_visible": true,
      "order_index": 1
    }
  },
  "use_territory_awareness": true,
  "availability_style": "TIME",
  "slot_interval_minutes": 60,
  "use_automated_user_assignment": true,
  "automated_user_assignment_strategy": "RECOMMENDED",
  "show_user_names": true,
  "use_instant_appointment_scheduling": true,
  "order_forms": [
    {
      "object": "ORDER_FORM",
      "id": "00000000-0000-4000-8000-000000000000",
      "title": "BQ's Photography Order Form",
      "type": "ARYEO",
      "url": "https://www.aryeo.com/order-forms/00000000-0000-4000-8000-000000000000",
      "is_public": true,
      "thumbnail_url": "https://picsum.photos/300",
      "use_territory_awareness": true,
      "availability_style": "TIME",
      "slot_interval_minutes": 60,
      "use_automated_user_assignment": true,
      "automated_user_assignment_strategy": "RECOMMENDED",
      "show_user_names": true,
      "require_upfront_payment": true,
      "upfront_payment_percentage": 50,
      "use_instant_appointment_scheduling": true,
      "form_settings": {},
      "owner": {
        "object": "GROUP",
        "id": "00000000-0000-4000-8000-000000000000",
        "type": "AGENT",
        "name": "John Doe Reality",
        "email": "john.doe@gmail.com",
        "phone": "6175550173",
        "website_url": "https://www.aryeo.com",
        "logo_url": "https://picsum.photos/300",
        "office_name": "John Doe Brokerage",
        "license_number": "12345678",
        "timezone": "America/New_York",
        "currency": "USD",
        "slug": "example-photography",
        "order_page_url": "https://example-photography.aryeo.com/order",
        "feature_flags": [
          "require_photographer_confirmations"
        ],
        "order_page_background_color": "#FF0000",
        "social_profiles": {
          "facebook_profile_url": "https://www.facebook.com/johndoe",
          "instagram_profile_url": "https://www.instagram.com/johndoe",
          "twitter_profile_url": "https://twitter.com/johndoe",
          "linkedin_profile_url": "https://www.linkedin.com/in/johndoe/",
          "zillow_profile_url": "https://www.zillow.com/profile/johndoe"
        },
        "default_order_form": {},
        "use_territory_awareness": true,
        "availability_style": "TIME",
        "slot_interval_minutes": 60,
        "use_automated_user_assignment": true,
        "automated_user_assignment_strategy": "RECOMMENDED",
        "show_user_names": true,
        "use_instant_appointment_scheduling": true,
        "allow_order_cancellation": true,
        "order_forms": [
          {}
        ],
        "owner": {
          "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
        },
        "users": [
          { … }
        ],
        "is_brokerage_or_brokerage_agent": true,
        "avatar_url": "https://picsum.photos/300",
        "internal_notes": "Internal notes about the group.",
        "team_members": [
          { … }
        ],
        "customer_group": "null",
        "custom_field_entries": [
          {}
        ],
        "created_at": "2021-06-30T20:30:00Z",
        "has_restricted_photographers": true,
        "is_payroll_enabled": true,
        "is_visible": true,
        "order_index": 1
      },
      "company": {
        "object": "GROUP",
        "id": "00000000-0000-4000-8000-000000000000",
        "type": "AGENT",
        "name": "John Doe Reality",
        "email": "john.doe@gmail.com",
        "phone": "6175550173",
        "website_url": "https://www.aryeo.com",
        "logo_url": "https://picsum.photos/300",
        "office_name": "John Doe Brokerage",
        "license_number": "12345678",
        "timezone": "America/New_York",
        "currency": "USD",
        "slug": "example-photography",
        "order_page_url": "https://example-photography.aryeo.com/order",
        "feature_flags": [
          "require_photographer_confirmations"
        ],
        "order_page_background_color": "#FF0000",
        "social_profiles": {
          "facebook_profile_url": "https://www.facebook.com/johndoe",
          "instagram_profile_url": "https://www.instagram.com/johndoe",
          "twitter_profile_url": "https://twitter.com/johndoe",
          "linkedin_profile_url": "https://www.linkedin.com/in/johndoe/",
          "zillow_profile_url": "https://www.zillow.com/profile/johndoe"
        },
        "default_order_form": {},
        "use_territory_awareness": true,
        "availability_style": "TIME",
        "slot_interval_minutes": 60,
        "use_automated_user_assignment": true,
        "automated_user_assignment_strategy": "RECOMMENDED",
        "show_user_names": true,
        "use_instant_appointment_scheduling": true,
        "allow_order_cancellation": true,
        "order_forms": [
          {}
        ],
        "owner": {
          "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
        },
        "users": [
          { … }
        ],
        "is_brokerage_or_brokerage_agent": true,
        "avatar_url": "https://picsum.photos/300",
        "internal_notes": "Internal notes about the group.",
        "team_members": [
          { … }
        ],
        "customer_group": "null",
        "custom_field_entries": [
          {}
        ],
        "created_at": "2021-06-30T20:30:00Z",
        "has_restricted_photographers": true,
        "is_payroll_enabled": true,
        "is_visible": true,
        "order_index": 1
      }
    }
  ],
  "users": [
    {
      "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
    }
  ],
  "is_brokerage_or_brokerage_agent": true,
  "avatar_url": "https://picsum.photos/300",
  "internal_notes": "Internal notes about the group.",
  "team_members": [
    {
      "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
    }
  ],
  "owner": {
    "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": {
          "name": "Some Company",
          "provider": "Auth0"
        }
      }
    ],
    "is_super": true
  },
  "social_profiles": {
    "facebook_profile_url": "https://www.facebook.com/johndoe",
    "instagram_profile_url": "https://www.instagram.com/johndoe",
    "twitter_profile_url": "https://twitter.com/johndoe",
    "linkedin_profile_url": "https://www.linkedin.com/in/johndoe/",
    "zillow_profile_url": "https://www.zillow.com/profile/johndoe"
  },
  "customer_group": "null",
  "has_restricted_photographers": true,
  "custom_field_entries": [
    {}
  ],
  "billing_address": "123 Main St, Anytown, USA 12345",
  "created_at": "2021-06-30T20:30:00Z",
  "restricted_photographers": [
    {}
  ],
  "customer_team_memberships": [
    {
      "object": "CUSTOMER_TEAM_MEMBERSHIP",
      "id": "00000000-0000-4000-8000-000000000000",
      "role": "admin",
      "invitation_accepted_at": "2025-04-01T05:59:59.999999Z",
      "status": "active",
      "customer_team": {
        "object": "CUSTOMER_TEAM",
        "id": "00000000-0000-4000-8000-000000000000",
        "name": "John Doe Customer Group",
        "description": "John Doe Customer Team is a customer team for John Doe.",
        "internal_notes": "John Doe's customer team normally doesn't work on Fridays.",
        "logo_url": "https://picsum.photos/640/480",
        "brokerage_name": "Grimes-Mante",
        "brokerage_website": "http://www.tillman.info/aut-odio-qui-voluptatibus",
        "affiliate_id": "JOHN_DOE",
        "should_display_original_price": true,
        "should_disable_automated_payment_reminder_email": true,
        "should_lock_downloads_before_payment": true,
        "order_form_id": "00000000-0000-4000-8000-000000000000",
        "created_at": "2025-03-07T13:59:03.000000Z",
        "is_showingtimeplus_team": true,
        "billing_customer": {
          "object": "GROUP",
          "id": "00000000-0000-4000-8000-000000000000",
          "type": "AGENT",
          "name": "John Doe Reality",
          "email": "john.doe@gmail.com",
          "phone": "6175550173",
          "website_url": "https://www.aryeo.com",
          "logo_url": "https://picsum.photos/300",
          "office_name": "John Doe Brokerage",
          "license_number": "12345678",
          "timezone": "America/New_York",
          "currency": "USD",
          "slug": "example-photography",
          "order_page_url": "https://example-photography.aryeo.com/order",
          "feature_flags": [ … ],
          "order_page_background_color": "#FF0000",
          "social_profiles": { … },
          "default_order_form": { … },
          "use_territory_awareness": true,
          "availability_style": "TIME",
          "slot_interval_minutes": 60,
          "use_automated_user_assignment": true,
          "automated_user_assignment_strategy": "RECOMMENDED",
          "show_user_names": true,
          "use_instant_appointment_scheduling": true,
          "allow_order_cancellation": true,
          "order_forms": [ … ],
          "owner": { … },
          "users": [ … ],
          "is_brokerage_or_brokerage_agent": true,
          "avatar_url": "https://picsum.photos/300",
          "internal_notes": "Internal notes about the group.",
          "team_members": [ … ],
          "customer_group": "null",
          "custom_field_entries": [ … ],
          "created_at": "2021-06-30T20:30:00Z",
          "has_restricted_photographers": true,
          "is_payroll_enabled": true,
          "is_visible": true,
          "order_index": 1
        },
        "billing_customer_pays_externally": true,
        "status": "active",
        "is_archived": true,
        "website": "https://www.aryeo.com",
        "is_default": true
      },
      "is_active": true,
      "is_archived": true,
      "is_deleted": true,
      "is_invited": true,
      "is_default": true,
      "created_at": "2025-04-01T05:59:59.999999Z",
      "customer_user": {
        "object": "USER",
        "id": "00000000-0000-4000-8000-000000000000",
        "name": "John",
        "email": "john.doe@gmail.com",
        "avatar_url": "https://picsum.photos/300",
        "phone": "123456789",
        "logo_url": "https://picsum.photos/300",
        "timezone": "America/New_York",
        "license_number": "12345678",
        "customer_team_memberships": [
          {}
        ],
        "created_at": "2021-06-30T20:30:00Z",
        "is_visible": true,
        "order_index": 1,
        "verification_status": "verified",
        "credit_balance_amount": 100,
        "total_balance_amount": 100,
        "is_showingtimeplus_user": true,
        "full_name": "John Doe",
        "first_name": "John",
        "last_name": "Doe",
        "phone_number": "1234567890",
        "profile_link": "https://picsum.photos/300",
        "internal_notes": "John Doe is a customer.",
        "agent_company_name": "John Doe Real Estate",
        "agent_license_number": "1234567890",
        "is_blocked_from_ordering": true,
        "has_restricted_photographers": true,
        "default_lock_downloads_before_payment": true,
        "default_allows_access_to_marketing_material": true,
        "avalara_customer_code": "1234567890",
        "quickbooks_customer_id": "1234567890"
      },
      "listing_delivery_notification_enabled": true,
      "is_showingtimeplus_workspace_membership": true,
      "is_visible": true,
      "order_index": 1
    }
  ],
  "is_visible": true,
  "order_index": 1,
  "verification_status": "verified",
  "credit_balance_amount": 100,
  "total_balance_amount": 100,
  "is_showingtimeplus_user": true,
  "full_name": "John Doe",
  "first_name": "John",
  "last_name": "Doe",
  "phone_number": "1234567890",
  "profile_link": "https://picsum.photos/300",
  "agent_company_name": "John Doe Real Estate",
  "agent_license_number": "1234567890",
  "is_blocked_from_ordering": true,
  "default_lock_downloads_before_payment": true,
  "default_allows_access_to_marketing_material": true,
  "avalara_customer_code": "1234567890",
  "quickbooks_customer_id": "1234567890"
}

Store customer user credit transaction.

Request

Store customer user credit transaction.

external: true
Security
Token
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: false
external: true
Security
Token
Query
includestring[ 0 .. 255 ] characters

Comma separated list of optional data to include in the response.

Example: include=users
filter[exclude_ids]string[ 0 .. 255 ] characters

Comma separated list of customer user IDs to exclude from the response.

Example: filter[exclude_ids]=00000000-0000-4000-8000-000000000000
filter[email_domain]string[ 0 .. 255 ] characters

Filter customers by email domain.

Example: filter[email_domain]=gmail.com
filter[search]string[ 0 .. 255 ] characters

Filter customers by search.

Example: filter[search]=john
filter[email]string[ 0 .. 255 ] characters

Filter customers by email.

Example: filter[email]=john.doe@gmail.com
filter[phone]string[ 0 .. 255 ] characters

Filter customers by phone.

Example: filter[phone]=1234567890
filter[customer_team_ids]string[ 0 .. 255 ] characters

Filter customers by customer team IDs.

Example: filter[customer_team_ids]=00000000-0000-4000-8000-000000000000
filter[name]string[ 0 .. 255 ] characters

Filter customers by name.

Example: filter[name]=John Doe
sortstring[ 1 .. 100 ] characters

Comma separated list of fields used for sorting. Placing a minus symbol in front of a field name sorts in descending order. Defaults to -created_at.

Example: sort=-created_at
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

GroupCustomerCollection

Bodyapplication/json
statusstring[ 0 .. 255 ] charactersrequired

What was the state of the request?

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

A collection of objects.

metaobject(PaginationMeta)
linksobject(PaginationLinks)
timestampstring or null(date-time)= 20 characters

The request timestamp (ISO 8601).

Example: "2021-06-30T20:30:00Z"
Response
application/json
{
  "status": "success",
  "data": [
    {
      "object": "GROUP",
      "id": "00000000-0000-4000-8000-000000000000",
      "type": "AGENT",
      "name": "John Doe Reality",
      "email": "john.doe@gmail.com",
      "phone": "6175550173",
      "website_url": "https://www.aryeo.com",
      "logo_url": "https://picsum.photos/300",
      "office_name": "John Doe Brokerage",
      "license_number": "12345678",
      "timezone": "America/New_York",
      "currency": "USD",
      "slug": "example-photography",
      "order_page_url": "https://example-photography.aryeo.com/order",
      "feature_flags": [
        "require_photographer_confirmations"
      ],
      "order_page_background_color": "#FF0000",
      "default_order_form": {
        "object": "ORDER_FORM",
        "id": "00000000-0000-4000-8000-000000000000",
        "title": "BQ's Photography Order Form",
        "type": "ARYEO",
        "url": "https://www.aryeo.com/order-forms/00000000-0000-4000-8000-000000000000",
        "is_public": true,
        "thumbnail_url": "https://picsum.photos/300",
        "use_territory_awareness": true,
        "availability_style": "TIME",
        "slot_interval_minutes": 60,
        "use_automated_user_assignment": true,
        "automated_user_assignment_strategy": "RECOMMENDED",
        "show_user_names": true,
        "require_upfront_payment": true,
        "upfront_payment_percentage": 50,
        "use_instant_appointment_scheduling": true,
        "form_settings": {},
        "owner": {
          "object": "GROUP",
          "id": "00000000-0000-4000-8000-000000000000",
          "type": "AGENT",
          "name": "John Doe Reality",
          "email": "john.doe@gmail.com",
          "phone": "6175550173",
          "website_url": "https://www.aryeo.com",
          "logo_url": "https://picsum.photos/300",
          "office_name": "John Doe Brokerage",
          "license_number": "12345678",
          "timezone": "America/New_York",
          "currency": "USD",
          "slug": "example-photography",
          "order_page_url": "https://example-photography.aryeo.com/order",
          "feature_flags": [ … ],
          "order_page_background_color": "#FF0000",
          "social_profiles": { … },
          "default_order_form": {},
          "use_territory_awareness": true,
          "availability_style": "TIME",
          "slot_interval_minutes": 60,
          "use_automated_user_assignment": true,
          "automated_user_assignment_strategy": "RECOMMENDED",
          "show_user_names": true,
          "use_instant_appointment_scheduling": true,
          "allow_order_cancellation": true,
          "order_forms": [ … ],
          "owner": { … },
          "users": [ … ],
          "is_brokerage_or_brokerage_agent": true,
          "avatar_url": "https://picsum.photos/300",
          "internal_notes": "Internal notes about the group.",
          "team_members": [ … ],
          "customer_group": "null",
          "custom_field_entries": [ … ],
          "created_at": "2021-06-30T20:30:00Z",
          "has_restricted_photographers": true,
          "is_payroll_enabled": true,
          "is_visible": true,
          "order_index": 1
        },
        "company": {
          "object": "GROUP",
          "id": "00000000-0000-4000-8000-000000000000",
          "type": "AGENT",
          "name": "John Doe Reality",
          "email": "john.doe@gmail.com",
          "phone": "6175550173",
          "website_url": "https://www.aryeo.com",
          "logo_url": "https://picsum.photos/300",
          "office_name": "John Doe Brokerage",
          "license_number": "12345678",
          "timezone": "America/New_York",
          "currency": "USD",
          "slug": "example-photography",
          "order_page_url": "https://example-photography.aryeo.com/order",
          "feature_flags": [ … ],
          "order_page_background_color": "#FF0000",
          "social_profiles": { … },
          "default_order_form": {},
          "use_territory_awareness": true,
          "availability_style": "TIME",
          "slot_interval_minutes": 60,
          "use_automated_user_assignment": true,
          "automated_user_assignment_strategy": "RECOMMENDED",
          "show_user_names": true,
          "use_instant_appointment_scheduling": true,
          "allow_order_cancellation": true,
          "order_forms": [ … ],
          "owner": { … },
          "users": [ … ],
          "is_brokerage_or_brokerage_agent": true,
          "avatar_url": "https://picsum.photos/300",
          "internal_notes": "Internal notes about the group.",
          "team_members": [ … ],
          "customer_group": "null",
          "custom_field_entries": [ … ],
          "created_at": "2021-06-30T20:30:00Z",
          "has_restricted_photographers": true,
          "is_payroll_enabled": true,
          "is_visible": true,
          "order_index": 1
        }
      },
      "use_territory_awareness": true,
      "availability_style": "TIME",
      "slot_interval_minutes": 60,
      "use_automated_user_assignment": true,
      "automated_user_assignment_strategy": "RECOMMENDED",
      "show_user_names": true,
      "use_instant_appointment_scheduling": true,
      "order_forms": [
        {
          "object": "ORDER_FORM",
          "id": "00000000-0000-4000-8000-000000000000",
          "title": "BQ's Photography Order Form",
          "type": "ARYEO",
          "url": "https://www.aryeo.com/order-forms/00000000-0000-4000-8000-000000000000",
          "is_public": true,
          "thumbnail_url": "https://picsum.photos/300",
          "use_territory_awareness": true,
          "availability_style": "TIME",
          "slot_interval_minutes": 60,
          "use_automated_user_assignment": true,
          "automated_user_assignment_strategy": "RECOMMENDED",
          "show_user_names": true,
          "require_upfront_payment": true,
          "upfront_payment_percentage": 50,
          "use_instant_appointment_scheduling": true,
          "form_settings": {},
          "owner": { … },
          "company": { … }
        }
      ],
      "users": [
        {
          "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
        }
      ],
      "is_brokerage_or_brokerage_agent": true,
      "avatar_url": "https://picsum.photos/300",
      "internal_notes": "Internal notes about the group.",
      "team_members": [
        {
          "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
        }
      ],
      "owner": {
        "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
      },
      "social_profiles": {
        "facebook_profile_url": "https://www.facebook.com/johndoe",
        "instagram_profile_url": "https://www.instagram.com/johndoe",
        "twitter_profile_url": "https://twitter.com/johndoe",
        "linkedin_profile_url": "https://www.linkedin.com/in/johndoe/",
        "zillow_profile_url": "https://www.zillow.com/profile/johndoe"
      },
      "customer_group": "null",
      "has_restricted_photographers": true,
      "custom_field_entries": [
        {}
      ],
      "billing_address": "123 Main St, Anytown, USA 12345",
      "created_at": "2021-06-30T20:30:00Z",
      "restricted_photographers": [
        {}
      ],
      "customer_team_memberships": [
        {
          "object": "CUSTOMER_TEAM_MEMBERSHIP",
          "id": "00000000-0000-4000-8000-000000000000",
          "role": "admin",
          "invitation_accepted_at": "2025-04-01T05:59:59.999999Z",
          "status": "active",
          "customer_team": { … },
          "is_active": true,
          "is_archived": true,
          "is_deleted": true,
          "is_invited": true,
          "is_default": true,
          "created_at": "2025-04-01T05:59:59.999999Z",
          "customer_user": { … },
          "listing_delivery_notification_enabled": true,
          "is_showingtimeplus_workspace_membership": true,
          "is_visible": true,
          "order_index": 1
        }
      ],
      "is_visible": true,
      "order_index": 1,
      "verification_status": "verified",
      "credit_balance_amount": 100,
      "total_balance_amount": 100,
      "is_showingtimeplus_user": true,
      "full_name": "John Doe",
      "first_name": "John",
      "last_name": "Doe",
      "phone_number": "1234567890",
      "profile_link": "https://picsum.photos/300",
      "agent_company_name": "John Doe Real Estate",
      "agent_license_number": "1234567890",
      "is_blocked_from_ordering": true,
      "default_lock_downloads_before_payment": true,
      "default_allows_access_to_marketing_material": true,
      "avalara_customer_code": "1234567890",
      "quickbooks_customer_id": "1234567890"
    }
  ],
  "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 a customer.

Request

Create a customer.

undocumented: false
external: true
Security
Token
Bodyapplication/json

CustomerPostPayload

owner_first_namestring[ 0 .. 255 ] charactersrequired

First name of the customer owner.

Example: "John"
owner_last_namestring[ 0 .. 255 ] charactersrequired

Last name of the customer owner.

Example: "Doe"
emailstring[ 0 .. 255 ] charactersrequired

Email address of the customer owner.

Example: "john.doe@gmail.com"
phonestring or null[ 0 .. 255 ] characters

A phone number represented in whichever standards specified by the user, typically ###-###-#### (separated by hyphens).

Example: "(123) 456-7890"
avatar_urlstring or null(uri)[ 0 .. 255 ] characters

The avatar image URL of the customer.

Example: "https://picsum.photos/300"
logo_urlstring or null(uri)[ 0 .. 255 ] characters

The logo image URL of the customer.

Example: "https://picsum.photos/300"
website_urlstring or null(uri)[ 0 .. 255 ] characters

The website URL of the customer.

Example: "https://www.john-doe-realty.com"
team_namestring or null[ 0 .. 255 ] characters

The name of the customer team.

Example: "John Doe Realty"
descriptionstring or null[ 0 .. 2550 ] characters

The description of the customer.

Example: "John Doe Realty is a real estate company that specializes in selling homes in Space City."
office_namestring or null[ 0 .. 255 ] characters

The name of the office.

Example: "John Doe Realty"
customer_team_idstring or null[ 0 .. 255 ] characters

The ID of the customer team.

Example: "123e4567-e89b-12d3-a456-426614174000"
license_numberstring or null[ 0 .. 255 ] characters

The license number of a real estate agent.

Example: "12345678"
timezonestring or null[ 0 .. 255 ] characters

The default timezone for the customer.

Example: "America/New_York"
const resp = await fetch(
  `https://docs.aryeo.com/_mock/api/aryeo/customers`,
  {
    method: 'POST',
    headers: {
      'Content-Type': 'application/json',
      Authorization: 'Bearer <YOUR_TOKEN_HERE>'
    },
    body: JSON.stringify({
      owner_first_name: 'John',
      owner_last_name: 'Doe',
      email: 'john.doe@gmail.com',
      phone: '(123) 456-7890',
      avatar_url: 'https://picsum.photos/300',
      logo_url: 'https://picsum.photos/300',
      website_url: 'https://www.john-doe-realty.com',
      team_name: 'John Doe Realty',
      description: 'John Doe Realty is a real estate company that specializes in selling homes in Space City.',
      office_name: 'John Doe Realty',
      customer_team_id: '123e4567-e89b-12d3-a456-426614174000',
      license_number: '12345678',
      timezone: 'America/New_York'
    })
  }
);

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

Responses

GroupCustomerResource

Bodyapplication/json
statusstring[ 0 .. 255 ] charactersrequired

What was the state of the request?

Example: "success"
dataobject(GroupCustomer)
timestampstring or null(date-time)= 20 characters

The request timestamp (ISO 8601).

Example: "2021-06-30T20:30:00Z"
Response
application/json
{
  "status": "success",
  "data": {
    "object": "GROUP",
    "id": "00000000-0000-4000-8000-000000000000",
    "type": "AGENT",
    "name": "John Doe Reality",
    "email": "john.doe@gmail.com",
    "phone": "6175550173",
    "website_url": "https://www.aryeo.com",
    "logo_url": "https://picsum.photos/300",
    "office_name": "John Doe Brokerage",
    "license_number": "12345678",
    "timezone": "America/New_York",
    "currency": "USD",
    "slug": "example-photography",
    "order_page_url": "https://example-photography.aryeo.com/order",
    "feature_flags": [
      "require_photographer_confirmations"
    ],
    "order_page_background_color": "#FF0000",
    "default_order_form": {
      "object": "ORDER_FORM",
      "id": "00000000-0000-4000-8000-000000000000",
      "title": "BQ's Photography Order Form",
      "type": "ARYEO",
      "url": "https://www.aryeo.com/order-forms/00000000-0000-4000-8000-000000000000",
      "is_public": true,
      "thumbnail_url": "https://picsum.photos/300",
      "use_territory_awareness": true,
      "availability_style": "TIME",
      "slot_interval_minutes": 60,
      "use_automated_user_assignment": true,
      "automated_user_assignment_strategy": "RECOMMENDED",
      "show_user_names": true,
      "require_upfront_payment": true,
      "upfront_payment_percentage": 50,
      "use_instant_appointment_scheduling": true,
      "form_settings": {},
      "owner": {
        "object": "GROUP",
        "id": "00000000-0000-4000-8000-000000000000",
        "type": "AGENT",
        "name": "John Doe Reality",
        "email": "john.doe@gmail.com",
        "phone": "6175550173",
        "website_url": "https://www.aryeo.com",
        "logo_url": "https://picsum.photos/300",
        "office_name": "John Doe Brokerage",
        "license_number": "12345678",
        "timezone": "America/New_York",
        "currency": "USD",
        "slug": "example-photography",
        "order_page_url": "https://example-photography.aryeo.com/order",
        "feature_flags": [
          "require_photographer_confirmations"
        ],
        "order_page_background_color": "#FF0000",
        "social_profiles": {
          "facebook_profile_url": "https://www.facebook.com/johndoe",
          "instagram_profile_url": "https://www.instagram.com/johndoe",
          "twitter_profile_url": "https://twitter.com/johndoe",
          "linkedin_profile_url": "https://www.linkedin.com/in/johndoe/",
          "zillow_profile_url": "https://www.zillow.com/profile/johndoe"
        },
        "default_order_form": {},
        "use_territory_awareness": true,
        "availability_style": "TIME",
        "slot_interval_minutes": 60,
        "use_automated_user_assignment": true,
        "automated_user_assignment_strategy": "RECOMMENDED",
        "show_user_names": true,
        "use_instant_appointment_scheduling": true,
        "allow_order_cancellation": true,
        "order_forms": [
          {}
        ],
        "owner": {
          "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
        },
        "users": [
          { … }
        ],
        "is_brokerage_or_brokerage_agent": true,
        "avatar_url": "https://picsum.photos/300",
        "internal_notes": "Internal notes about the group.",
        "team_members": [
          { … }
        ],
        "customer_group": "null",
        "custom_field_entries": [
          {}
        ],
        "created_at": "2021-06-30T20:30:00Z",
        "has_restricted_photographers": true,
        "is_payroll_enabled": true,
        "is_visible": true,
        "order_index": 1
      },
      "company": {
        "object": "GROUP",
        "id": "00000000-0000-4000-8000-000000000000",
        "type": "AGENT",
        "name": "John Doe Reality",
        "email": "john.doe@gmail.com",
        "phone": "6175550173",
        "website_url": "https://www.aryeo.com",
        "logo_url": "https://picsum.photos/300",
        "office_name": "John Doe Brokerage",
        "license_number": "12345678",
        "timezone": "America/New_York",
        "currency": "USD",
        "slug": "example-photography",
        "order_page_url": "https://example-photography.aryeo.com/order",
        "feature_flags": [
          "require_photographer_confirmations"
        ],
        "order_page_background_color": "#FF0000",
        "social_profiles": {
          "facebook_profile_url": "https://www.facebook.com/johndoe",
          "instagram_profile_url": "https://www.instagram.com/johndoe",
          "twitter_profile_url": "https://twitter.com/johndoe",
          "linkedin_profile_url": "https://www.linkedin.com/in/johndoe/",
          "zillow_profile_url": "https://www.zillow.com/profile/johndoe"
        },
        "default_order_form": {},
        "use_territory_awareness": true,
        "availability_style": "TIME",
        "slot_interval_minutes": 60,
        "use_automated_user_assignment": true,
        "automated_user_assignment_strategy": "RECOMMENDED",
        "show_user_names": true,
        "use_instant_appointment_scheduling": true,
        "allow_order_cancellation": true,
        "order_forms": [
          {}
        ],
        "owner": {
          "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
        },
        "users": [
          { … }
        ],
        "is_brokerage_or_brokerage_agent": true,
        "avatar_url": "https://picsum.photos/300",
        "internal_notes": "Internal notes about the group.",
        "team_members": [
          { … }
        ],
        "customer_group": "null",
        "custom_field_entries": [
          {}
        ],
        "created_at": "2021-06-30T20:30:00Z",
        "has_restricted_photographers": true,
        "is_payroll_enabled": true,
        "is_visible": true,
        "order_index": 1
      }
    },
    "use_territory_awareness": true,
    "availability_style": "TIME",
    "slot_interval_minutes": 60,
    "use_automated_user_assignment": true,
    "automated_user_assignment_strategy": "RECOMMENDED",
    "show_user_names": true,
    "use_instant_appointment_scheduling": true,
    "order_forms": [
      {
        "object": "ORDER_FORM",
        "id": "00000000-0000-4000-8000-000000000000",
        "title": "BQ's Photography Order Form",
        "type": "ARYEO",
        "url": "https://www.aryeo.com/order-forms/00000000-0000-4000-8000-000000000000",
        "is_public": true,
        "thumbnail_url": "https://picsum.photos/300",
        "use_territory_awareness": true,
        "availability_style": "TIME",
        "slot_interval_minutes": 60,
        "use_automated_user_assignment": true,
        "automated_user_assignment_strategy": "RECOMMENDED",
        "show_user_names": true,
        "require_upfront_payment": true,
        "upfront_payment_percentage": 50,
        "use_instant_appointment_scheduling": true,
        "form_settings": {},
        "owner": {
          "object": "GROUP",
          "id": "00000000-0000-4000-8000-000000000000",
          "type": "AGENT",
          "name": "John Doe Reality",
          "email": "john.doe@gmail.com",
          "phone": "6175550173",
          "website_url": "https://www.aryeo.com",
          "logo_url": "https://picsum.photos/300",
          "office_name": "John Doe Brokerage",
          "license_number": "12345678",
          "timezone": "America/New_York",
          "currency": "USD",
          "slug": "example-photography",
          "order_page_url": "https://example-photography.aryeo.com/order",
          "feature_flags": [ … ],
          "order_page_background_color": "#FF0000",
          "social_profiles": { … },
          "default_order_form": {},
          "use_territory_awareness": true,
          "availability_style": "TIME",
          "slot_interval_minutes": 60,
          "use_automated_user_assignment": true,
          "automated_user_assignment_strategy": "RECOMMENDED",
          "show_user_names": true,
          "use_instant_appointment_scheduling": true,
          "allow_order_cancellation": true,
          "order_forms": [ … ],
          "owner": { … },
          "users": [ … ],
          "is_brokerage_or_brokerage_agent": true,
          "avatar_url": "https://picsum.photos/300",
          "internal_notes": "Internal notes about the group.",
          "team_members": [ … ],
          "customer_group": "null",
          "custom_field_entries": [ … ],
          "created_at": "2021-06-30T20:30:00Z",
          "has_restricted_photographers": true,
          "is_payroll_enabled": true,
          "is_visible": true,
          "order_index": 1
        },
        "company": {
          "object": "GROUP",
          "id": "00000000-0000-4000-8000-000000000000",
          "type": "AGENT",
          "name": "John Doe Reality",
          "email": "john.doe@gmail.com",
          "phone": "6175550173",
          "website_url": "https://www.aryeo.com",
          "logo_url": "https://picsum.photos/300",
          "office_name": "John Doe Brokerage",
          "license_number": "12345678",
          "timezone": "America/New_York",
          "currency": "USD",
          "slug": "example-photography",
          "order_page_url": "https://example-photography.aryeo.com/order",
          "feature_flags": [ … ],
          "order_page_background_color": "#FF0000",
          "social_profiles": { … },
          "default_order_form": {},
          "use_territory_awareness": true,
          "availability_style": "TIME",
          "slot_interval_minutes": 60,
          "use_automated_user_assignment": true,
          "automated_user_assignment_strategy": "RECOMMENDED",
          "show_user_names": true,
          "use_instant_appointment_scheduling": true,
          "allow_order_cancellation": true,
          "order_forms": [ … ],
          "owner": { … },
          "users": [ … ],
          "is_brokerage_or_brokerage_agent": true,
          "avatar_url": "https://picsum.photos/300",
          "internal_notes": "Internal notes about the group.",
          "team_members": [ … ],
          "customer_group": "null",
          "custom_field_entries": [ … ],
          "created_at": "2021-06-30T20:30:00Z",
          "has_restricted_photographers": true,
          "is_payroll_enabled": true,
          "is_visible": true,
          "order_index": 1
        }
      }
    ],
    "users": [
      {
        "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
      }
    ],
    "is_brokerage_or_brokerage_agent": true,
    "avatar_url": "https://picsum.photos/300",
    "internal_notes": "Internal notes about the group.",
    "team_members": [
      {
        "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
      }
    ],
    "owner": {
      "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
    },
    "social_profiles": {
      "facebook_profile_url": "https://www.facebook.com/johndoe",
      "instagram_profile_url": "https://www.instagram.com/johndoe",
      "twitter_profile_url": "https://twitter.com/johndoe",
      "linkedin_profile_url": "https://www.linkedin.com/in/johndoe/",
      "zillow_profile_url": "https://www.zillow.com/profile/johndoe"
    },
    "customer_group": "null",
    "has_restricted_photographers": true,
    "custom_field_entries": [
      {}
    ],
    "billing_address": "123 Main St, Anytown, USA 12345",
    "created_at": "2021-06-30T20:30:00Z",
    "restricted_photographers": [
      {}
    ],
    "customer_team_memberships": [
      {
        "object": "CUSTOMER_TEAM_MEMBERSHIP",
        "id": "00000000-0000-4000-8000-000000000000",
        "role": "admin",
        "invitation_accepted_at": "2025-04-01T05:59:59.999999Z",
        "status": "active",
        "customer_team": {
          "object": "CUSTOMER_TEAM",
          "id": "00000000-0000-4000-8000-000000000000",
          "name": "John Doe Customer Group",
          "description": "John Doe Customer Team is a customer team for John Doe.",
          "internal_notes": "John Doe's customer team normally doesn't work on Fridays.",
          "logo_url": "https://picsum.photos/640/480",
          "brokerage_name": "Grimes-Mante",
          "brokerage_website": "http://www.tillman.info/aut-odio-qui-voluptatibus",
          "affiliate_id": "JOHN_DOE",
          "should_display_original_price": true,
          "should_disable_automated_payment_reminder_email": true,
          "should_lock_downloads_before_payment": true,
          "order_form_id": "00000000-0000-4000-8000-000000000000",
          "created_at": "2025-03-07T13:59:03.000000Z",
          "is_showingtimeplus_team": true,
          "billing_customer": { … },
          "billing_customer_pays_externally": true,
          "status": "active",
          "is_archived": true,
          "website": "https://www.aryeo.com",
          "is_default": true
        },
        "is_active": true,
        "is_archived": true,
        "is_deleted": true,
        "is_invited": true,
        "is_default": true,
        "created_at": "2025-04-01T05:59:59.999999Z",
        "customer_user": {
          "object": "USER",
          "id": "00000000-0000-4000-8000-000000000000",
          "name": "John",
          "email": "john.doe@gmail.com",
          "avatar_url": "https://picsum.photos/300",
          "phone": "123456789",
          "logo_url": "https://picsum.photos/300",
          "timezone": "America/New_York",
          "license_number": "12345678",
          "customer_team_memberships": [ … ],
          "created_at": "2021-06-30T20:30:00Z",
          "is_visible": true,
          "order_index": 1,
          "verification_status": "verified",
          "credit_balance_amount": 100,
          "total_balance_amount": 100,
          "is_showingtimeplus_user": true,
          "full_name": "John Doe",
          "first_name": "John",
          "last_name": "Doe",
          "phone_number": "1234567890",
          "profile_link": "https://picsum.photos/300",
          "internal_notes": "John Doe is a customer.",
          "agent_company_name": "John Doe Real Estate",
          "agent_license_number": "1234567890",
          "is_blocked_from_ordering": true,
          "has_restricted_photographers": true,
          "default_lock_downloads_before_payment": true,
          "default_allows_access_to_marketing_material": true,
          "avalara_customer_code": "1234567890",
          "quickbooks_customer_id": "1234567890"
        },
        "listing_delivery_notification_enabled": true,
        "is_showingtimeplus_workspace_membership": true,
        "is_visible": true,
        "order_index": 1
      }
    ],
    "is_visible": true,
    "order_index": 1,
    "verification_status": "verified",
    "credit_balance_amount": 100,
    "total_balance_amount": 100,
    "is_showingtimeplus_user": true,
    "full_name": "John Doe",
    "first_name": "John",
    "last_name": "Doe",
    "phone_number": "1234567890",
    "profile_link": "https://picsum.photos/300",
    "agent_company_name": "John Doe Real Estate",
    "agent_license_number": "1234567890",
    "is_blocked_from_ordering": true,
    "default_lock_downloads_before_payment": true,
    "default_allows_access_to_marketing_material": true,
    "avalara_customer_code": "1234567890",
    "quickbooks_customer_id": "1234567890"
  },
  "timestamp": "2021-06-30T20:30:00Z"
}

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

Videos

Operations related to videos.

Operations