# List customer users.

List customer users.

Endpoint: GET /customer-users
Version: 1.0.0
Security: Token

## Query parameters:

  - `include` (string)
    Comma separated list of optional data to include in the response.
    Example: "users"

  - `filter[exclude_customers_in_team]` (string)
    Filter customers by customer team ID.
    Example: "00000000-0000-4000-8000-000000000000"

  - `filter[exclude_customers_in_pricing_plan]` (string)
    Filter customers by pricing plan ID.
    Example: "00000000-0000-4000-8000-000000000000"

  - `filter[exclude_customers_with_individual_pricing_plan]` (boolean)
    Filter customers that do not have an individual pricing plan.
    Example: true

  - `filter[exclude_customers_with_team_pricing_plan]` (boolean)
    Filter customers that do not have a team pricing plan.
    Example: true

  - `filter[customer_team_ids]` (string)
    Comma separated list of customer team IDs.
    Example: "00000000-0000-4000-8000-000000000000"

  - `filter[has_active_team_memberships]` (boolean)
    Filter customers that have active team memberships.
    Example: true

  - `filter[search]` (string)
    Filter customers by search.
    Example: "john"

  - `sort` (string)
    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: "-created_at"

## Response 200 fields (application/json):

  - `data` (array,null, required)
    A collection of objects.

  - `data.object` (string,null)
    A canonical value representing a resource.
    Example: "USER"

  - `data.id` (string, required)
    ID of the entity. UUID Version 4.
    Example: "00000000-0000-4000-8000-000000000000"

  - `data.name` (string,null)
    Name of the user.
    Example: "John"

  - `data.email` (string, required)
    Email address of the user.
    Example: "john.doe@gmail.com"

  - `data.avatar_url` (string,null)
    The avatar image URL of a user.
    Example: "https://picsum.photos/300"

  - `data.phone` (string,null)
    A phone number represented in whichever standards specified by the user, typically ###-###-#### (separated by hyphens).
    Example: "123456789"

  - `data.logo_url` (string,null)
    The logo URL of a user.
    Example: "https://picsum.photos/300"

  - `data.timezone` (string,null)
    The default timezone for the customer.
    Example: "America/New_York"

  - `data.license_number` (string,null)
    The license number of a real estate agent. Only returned if group's type is AGENT.
    Example: "12345678"

  - `data.customer_team_memberships` (array)

  - `data.customer_team_memberships.role` (string, required)
    The role of the customer team membership.
    Enum: "admin", "member"

  - `data.customer_team_memberships.invitation_accepted_at` (string,null)
    The date and time (ISO 8601 format) when the invitation was accepted.
    Example: "2025-04-01T05:59:59.999999Z"

  - `data.customer_team_memberships.status` (string, required)
    The status of the customer team membership.
    Enum: "deleted", "archived", "revoked", "active", "invited"

  - `data.customer_team_memberships.customer_team` (object, required)
    A customer group is a legacy name for what is now a customer team. A customer team is a container for customers, allowing you to apply settings such as price overrides and billing customer configurations in bulk.

  - `data.customer_team_memberships.customer_team.name` (string, required)
    The name of the customer team.
    Example: "John Doe Customer Group"

  - `data.customer_team_memberships.customer_team.description` (string,null)
    The description of the customer team.
    Example: "John Doe Customer Team is a customer team for John Doe."

  - `data.customer_team_memberships.customer_team.internal_notes` (string,null)
    The internal notes of the customer team.
    Example: "John Doe's customer team normally doesn't work on Fridays."

  - `data.customer_team_memberships.customer_team.logo_url` (string,null)
    The logo image URL of the customer team.
    Example: "https://picsum.photos/640/480"

  - `data.customer_team_memberships.customer_team.brokerage_name` (string,null)
    The name of the brokerage team.
    Example: "Grimes-Mante"

  - `data.customer_team_memberships.customer_team.brokerage_website` (string,null)
    The website URL of the brokerage team.
    Example: "http://www.tillman.info/aut-odio-qui-voluptatibus"

  - `data.customer_team_memberships.customer_team.affiliate_id` (string,null)
    The affliate ID for the customer team.
    Example: "JOHN_DOE"

  - `data.customer_team_memberships.customer_team.should_display_original_price` (boolean)
    Indicates if original prices should be displayed for this customer team.
    Example: true

  - `data.customer_team_memberships.customer_team.should_disable_automated_payment_reminder_email` (boolean)
    Indicates if automated payment reminder emails should be disabled for this customer team.
    Example: true

  - `data.customer_team_memberships.customer_team.should_lock_downloads_before_payment` (boolean,null)
    Indicates if the downloads should be locked before payment for this customer team.
    Example: true

  - `data.customer_team_memberships.customer_team.order_form_id` (string,null)
    The ID of the order form.
    Example: "00000000-0000-4000-8000-000000000000"

  - `data.customer_team_memberships.customer_team.created_at` (string,null)
    The date and time (ISO 8601 format) when the customer team was created.
    Example: "2025-03-07T13:59:03.000000Z"

  - `data.customer_team_memberships.customer_team.is_showingtimeplus_team` (boolean)
    Indicates if the customer team is a ShowingTime team.
    Example: true

  - `data.customer_team_memberships.customer_team.billing_customer` (object)
    A collection of users that can interact with the Aryeo platform. Permissions and properties are determined based on the group's type which can be creator, agent, or brokerage.

  - `data.customer_team_memberships.customer_team.billing_customer.type` (string, required)
    The type of the group. Can be CREATOR, AGENT, or BROKERAGE, and may dictate the attributes of the group returned.
    Enum: "CREATOR", "AGENT", "BROKERAGE"

  - `data.customer_team_memberships.customer_team.billing_customer.name` (string, required)
    The name of the group.
    Example: "John Doe Reality"

  - `data.customer_team_memberships.customer_team.billing_customer.email` (string,null)
    The email address of a group.
    Example: "john.doe@gmail.com"

  - `data.customer_team_memberships.customer_team.billing_customer.phone` (string,null)
    A phone number represented in whichever standards specified by the group, typically ###-###-#### (separated by hyphens).
    Example: "6175550173"

  - `data.customer_team_memberships.customer_team.billing_customer.website_url` (string,null)
    The website URL of a group.
    Example: "https://www.aryeo.com"

  - `data.customer_team_memberships.customer_team.billing_customer.logo_url` (string,null)
    The logo URL of a group.
    Example: "https://picsum.photos/300"

  - `data.customer_team_memberships.customer_team.billing_customer.office_name` (string,null)
    The name of the brokerage or team of a real estate agent. Only returned if group's type is AGENT.
    Example: "John Doe Brokerage"

  - `data.customer_team_memberships.customer_team.billing_customer.timezone` (string,null)
    The default timezone for the group.
    Example: "America/New_York"

  - `data.customer_team_memberships.customer_team.billing_customer.currency` (string)
    The default currency for the group.
    Enum: "USD", "CAD", "GBP", "CHF", "EUR", "AUD", "NZD", "ZAR", "DKK"

  - `data.customer_team_memberships.customer_team.billing_customer.slug` (string,null)
    The slug for the group.
    Example: "example-photography"

  - `data.customer_team_memberships.customer_team.billing_customer.order_page_url` (string,null)
    The order page URL for the group.
    Example: "https://example-photography.aryeo.com/order"

  - `data.customer_team_memberships.customer_team.billing_customer.feature_flags` (array,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", "database_external_calendar_events", "default_reschedule_toggle_false", "download_center_fb_boost_1", "embedded_payments", "housecall_pro", "idp_migration_in_progress", "listings_create_page", "listings_page", "min_hour_targets", "max_travel_distance", "quickbooks_app", "require_photographer_confirmations", "restricted_image_downloads", "showcase_app", "showcase_order_form_visibility_designations", "showingtime", "team_member_restrictions", "team_member_hide_customer_pii", "virtual_staging_ai", "virtuals1_custom_sms_notification_messages", "webhooks", "zapier", "zendesk", "zillow_3d_home", "zillow_media_exclusives", "zillow_photographer_branding", "zillow_rentals"

  - `data.customer_team_memberships.customer_team.billing_customer.order_page_background_color` (string,null)
    The background color for the order page (has a hex value) for the group.
    Example: "#FF0000"

  - `data.customer_team_memberships.customer_team.billing_customer.social_profiles` (object,null)
    External profile URLs for an agent or brokerage group.

  - `data.customer_team_memberships.customer_team.billing_customer.social_profiles.facebook_profile_url` (string,null)
    URL for Facebook.
    Example: "https://www.facebook.com/johndoe"

  - `data.customer_team_memberships.customer_team.billing_customer.social_profiles.instagram_profile_url` (string,null)
    URL for Instagram.
    Example: "https://www.instagram.com/johndoe"

  - `data.customer_team_memberships.customer_team.billing_customer.social_profiles.twitter_profile_url` (string,null)
    URL for Twitter.
    Example: "https://twitter.com/johndoe"

  - `data.customer_team_memberships.customer_team.billing_customer.social_profiles.linkedin_profile_url` (string,null)
    URL for LinkedIn.
    Example: "https://www.linkedin.com/in/johndoe/"

  - `data.customer_team_memberships.customer_team.billing_customer.social_profiles.zillow_profile_url` (string,null)
    URL for Zillow.
    Example: "https://www.zillow.com/profile/johndoe"

  - `data.customer_team_memberships.customer_team.billing_customer.default_order_form` (object)
    An order form is a form that is used to submit an order.

  - `data.customer_team_memberships.customer_team.billing_customer.default_order_form.title` (string, required)
    The title or name of the order form.
    Example: "BQ's Photography Order Form"

  - `data.customer_team_memberships.customer_team.billing_customer.default_order_form.type` (string, required)
    The type of the order form, indicating whether the order form is an Aryeo order form or that of another scheduling service provider.
    Enum: "ARYEO", "EXTERNAL"

  - `data.customer_team_memberships.customer_team.billing_customer.default_order_form.url` (string, required)
    A URL of a publicly-accessible webpage for this order form.
    Example: "https://www.aryeo.com/order-forms/00000000-0000-4000-8000-000000000000"

  - `data.customer_team_memberships.customer_team.billing_customer.default_order_form.is_public` (boolean)
    Indicates if the order form is publicly visible to all customers on the order form page
    Example: true

  - `data.customer_team_memberships.customer_team.billing_customer.default_order_form.thumbnail_url` (string,null)
    A thumbnail image URL for the order form.
    Example: "https://picsum.photos/300"

  - `data.customer_team_memberships.customer_team.billing_customer.default_order_form.use_territory_awareness` (boolean)
    Indicates if the order form is uses territories to filter available users and products.
    Example: true

  - `data.customer_team_memberships.customer_team.billing_customer.default_order_form.availability_style` (string)
    The scheduling style the order form should use to for timeslot selection.
    Enum: "TIME", "TIME_OF_DAY", "LEGACY", "DATETIME_PICKER"

  - `data.customer_team_memberships.customer_team.billing_customer.default_order_form.slot_interval_minutes` (integer)
    How frequently slotted available times are on the order form.
    Example: 60

  - `data.customer_team_memberships.customer_team.billing_customer.default_order_form.use_automated_user_assignment` (boolean)
    Indicates if the order form users auto-assignment of users to appointments.
    Example: true

  - `data.customer_team_memberships.customer_team.billing_customer.default_order_form.automated_user_assignment_strategy` (string)
    The assignment strategy the order form should use to assign users to appointments, if applicable.
    Enum: "RECOMMENDED", "HOURS_PRIORITY", "DISTANCE", "ROUND_ROBIN", "PRIORITY_LIST"

  - `data.customer_team_memberships.customer_team.billing_customer.default_order_form.show_user_names` (boolean)
    Indicates if the order form should display user's names after they have been assigned to an appointment.
    Example: true

  - `data.customer_team_memberships.customer_team.billing_customer.default_order_form.require_upfront_payment` (boolean)
    Indicates if the order form requires an upfront payment to place the order.
    Example: true

  - `data.customer_team_memberships.customer_team.billing_customer.default_order_form.upfront_payment_percentage` (integer,null)
    The percentage of the order form's total price that should be paid upfront.
    Example: 50

  - `data.customer_team_memberships.customer_team.billing_customer.default_order_form.use_instant_appointment_scheduling` (boolean)
    Indicates if the order form instantly schedules appointments as soon as the order is placed.
    Example: true

  - `data.customer_team_memberships.customer_team.billing_customer.default_order_form.form_settings` (object)
    The settings for the order form.

  - `data.customer_team_memberships.customer_team.billing_customer.default_order_form.owner` (object)
    A collection of users that can interact with the Aryeo platform. Permissions and properties are determined based on the group's type which can be creator, agent, or brokerage.

  - `data.customer_team_memberships.customer_team.billing_customer.default_order_form.company` (object)
    A collection of users that can interact with the Aryeo platform. Permissions and properties are determined based on the group's type which can be creator, agent, or brokerage.

  - `data.customer_team_memberships.customer_team.billing_customer.use_territory_awareness` (boolean,null)
    Indicates if the order form by default uses territories to filter available users and products.
    Example: true

  - `data.customer_team_memberships.customer_team.billing_customer.availability_style` (string,null)
    The scheduling style the order form should use for timeslot selection by default.
    Enum: "TIME", "TIME_OF_DAY", "LEGACY"

  - `data.customer_team_memberships.customer_team.billing_customer.slot_interval_minutes` (integer,null)
    How frequently slotted available times are on the order form by default.
    Example: 60

  - `data.customer_team_memberships.customer_team.billing_customer.use_automated_user_assignment` (boolean,null)
    Indicates if the order form uses auto-assignment of users to appointments.
    Example: true

  - `data.customer_team_memberships.customer_team.billing_customer.automated_user_assignment_strategy` (string,null)
    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"

  - `data.customer_team_memberships.customer_team.billing_customer.show_user_names` (boolean,null)
    Indicates if the order form by default should display user's names after they have been assigned to an appointment.
    Example: true

  - `data.customer_team_memberships.customer_team.billing_customer.use_instant_appointment_scheduling` (boolean,null)
    Indicates if the order form by default instantly schedules appointments as soon as the order is placed.
    Example: true

  - `data.customer_team_memberships.customer_team.billing_customer.allow_order_cancellation` (boolean,null)
    If the group is a company, then this indicates if company allows customers to cancel orders or order items.
    Example: true

  - `data.customer_team_memberships.customer_team.billing_customer.order_forms` (array,null)
    An array of order forms a vendor group provides for placing orders. Only returned if group's type is CREATOR.

  - `data.customer_team_memberships.customer_team.billing_customer.owner` (object,null)
    A record of a person on the Aryeo platform.

  - `data.customer_team_memberships.customer_team.billing_customer.owner.first_name` (string,null)
    First name of the user.
    Example: "John"

  - `data.customer_team_memberships.customer_team.billing_customer.owner.last_name` (string,null)
    Last name of the user.
    Example: "Doe"

  - `data.customer_team_memberships.customer_team.billing_customer.owner.full_name` (string,null)
    The full name of the user.
    Example: "John Doe"

  - `data.customer_team_memberships.customer_team.billing_customer.owner.internal_notes` (string,null)
    Internal notes for the user.
    Example: "Internal notes for the user."

  - `data.customer_team_memberships.customer_team.billing_customer.owner.status` (string)
    The status of the user.
    Enum: "active", "inactive", "new", "sso"

  - `data.customer_team_memberships.customer_team.billing_customer.owner.relationship` (string,null)
    Describes user's relationship (access level) to a specified group. Only returned if this resource is returned as a sub-resource of a group.
    Example: "owner"

  - `data.customer_team_memberships.customer_team.billing_customer.owner.sso_users` (array)
    The list of SSO users associated with this user.

  - `data.customer_team_memberships.customer_team.billing_customer.owner.sso_users.sso_id` (string, required)
    SSO ID of the user
    Example: "1234"

  - `data.customer_team_memberships.customer_team.billing_customer.owner.sso_users.sso_provider` (object)
    A SSO Provider contains the information pertaining to the SSO connection.

  - `data.customer_team_memberships.customer_team.billing_customer.owner.sso_users.sso_provider.name` (string, required)
    Name of the provider
    Example: "Some Company"

  - `data.customer_team_memberships.customer_team.billing_customer.owner.sso_users.sso_provider.provider` (string, required)
    Technology of the provider
    Example: "Auth0"

  - `data.customer_team_memberships.customer_team.billing_customer.owner.is_super` (boolean,null)
    Indicates if the user is a super user.
    Example: true

  - `data.customer_team_memberships.customer_team.billing_customer.users` (array,null)
    The Aryeo users associated with this group.

  - `data.customer_team_memberships.customer_team.billing_customer.is_brokerage_or_brokerage_agent` (boolean,null)
    Indicates if the group is a brokerage or brokerage agent.
    Example: true

  - `data.customer_team_memberships.customer_team.billing_customer.internal_notes` (string,null)
    Internal notes about the group.
    Example: "Internal notes about the group."

  - `data.customer_team_memberships.customer_team.billing_customer.team_members` (array,null)
    NOTE: Users do not have team members.

  - `data.customer_team_memberships.customer_team.billing_customer.customer_group` (string,null)
    NOTE: Users do not have customer groups and they are deprecated.
    Example: "null"

  - `data.customer_team_memberships.customer_team.billing_customer.custom_field_entries` (array,null)
    NOTE: Need to make a migration plan for this.

  - `data.customer_team_memberships.customer_team.billing_customer.created_at` (string,null)
    The date and time the group was created.
    Example: "2021-06-30T20:30:00Z"

  - `data.customer_team_memberships.customer_team.billing_customer.has_restricted_photographers` (boolean,null)
    Whether the group is restricted from booking appointments with certain photographers.
    Example: true

  - `data.customer_team_memberships.customer_team.billing_customer.is_payroll_enabled` (boolean,null)
    Indicates if the group has payroll enabled.
    Example: true

  - `data.customer_team_memberships.customer_team.billing_customer.is_visible` (boolean,null)
    Indicates if the group is visible.
    Example: true

  - `data.customer_team_memberships.customer_team.billing_customer.order_index` (integer,null)
    The order index of the group.
    Example: 1

  - `data.customer_team_memberships.customer_team.billing_customer_pays_externally` (boolean)
    Indicates if the billing customer team membership pays externally.
    Example: true

  - `data.customer_team_memberships.customer_team.status` (string)
    The status of the customer group.
    Enum: "any_status", "active", "archived"

  - `data.customer_team_memberships.customer_team.is_archived` (boolean)
    Indicates if the customer group is archived.
    Example: true

  - `data.customer_team_memberships.customer_team.website` (string,null)
    The website URL of the customer group.
    Example: "https://www.aryeo.com"

  - `data.customer_team_memberships.customer_team.is_default` (boolean,null)
    Indicates if the customer group is the default customer group.
    Example: true

  - `data.customer_team_memberships.is_active` (boolean)
    Whether the customer team membership is active.
    Example: true

  - `data.customer_team_memberships.is_archived` (boolean)
    Whether the customer team membership is archived.
    Example: true

  - `data.customer_team_memberships.is_deleted` (boolean)
    Whether the customer team membership is deleted.
    Example: true

  - `data.customer_team_memberships.is_invited` (boolean)
    Whether the customer team membership is invited.
    Example: true

  - `data.customer_team_memberships.is_default` (boolean)
    Whether the customer team membership is the default.
    Example: true

  - `data.customer_team_memberships.created_at` (string,null)
    The date and time (ISO 8601 format) when the customer team membership was created.
    Example: "2025-04-01T05:59:59.999999Z"

  - `data.customer_team_memberships.customer_user` (object)
    A record of a customer on the Aryeo platform.

  - `data.customer_team_memberships.listing_delivery_notification_enabled` (boolean)
    Whether the customer team membership has listing delivery notifications enabled.
    Example: true

  - `data.customer_team_memberships.is_showingtimeplus_workspace_membership` (boolean)
    Whether the customer team membership is a ShowingTime workspace membership.
    Example: true

  - `data.customer_team_memberships.is_visible` (boolean,null)
    Whether the customer team membership is visible.
    Example: true

  - `data.customer_team_memberships.order_index` (integer,null)
    The order index of the customer team membership.
    Example: 1

  - `data.created_at` (string)
    The date and time (ISO 8601 format) when the customer record was created.
    Example: "2021-06-30T20:30:00Z"

  - `data.is_visible` (boolean,null)
    Indicates if the customer is visible.
    Example: true

  - `data.order_index` (integer,null)
    The order index of the customer.
    Example: 1

  - `data.verification_status` (string)
    The verification status of the customer.
    Enum: "verified", "unverified", "new", "sso"

  - `data.credit_balance_amount` (number,null)
    The credit balance amount of the customer.
    Example: 100

  - `data.total_balance_amount` (number,null)
    The total balance amount of the customer.
    Example: 100

  - `data.is_showingtimeplus_user` (boolean)
    Whether the customer is a ShowingTime+ user.
    Example: true

  - `data.full_name` (string)
    The full name of the customer.
    Example: "John Doe"

  - `data.first_name` (string)
    The first name of the customer.
    Example: "John"

  - `data.last_name` (string)
    The last name of the customer.
    Example: "Doe"

  - `data.phone_number` (string,null)
    The phone number of the customer.
    Example: "1234567890"

  - `data.profile_link` (string,null)
    The profile link of the customer.
    Example: "https://picsum.photos/300"

  - `data.internal_notes` (string,null)
    The internal notes of the customer.
    Example: "John Doe is a customer."

  - `data.agent_company_name` (string,null)
    The agent company name of the customer.
    Example: "John Doe Real Estate"

  - `data.agent_license_number` (string,null)
    The agent license number of the customer.
    Example: "1234567890"

  - `data.is_blocked_from_ordering` (boolean)
    Whether the customer is blocked from ordering.
    Example: true

  - `data.has_restricted_photographers` (boolean)
    Whether the customer is restricted from booking appointments with certain photographers.
    Example: true

  - `data.default_lock_downloads_before_payment` (boolean,null)
    Whether the customer has locked media downloads before payment as the default download setting.
    Example: true

  - `data.default_allows_access_to_marketing_material` (boolean,null)
    Whether the customer has access to the marketing material builder.
    Example: true

  - `data.avalara_customer_code` (string,null)
    The Avalara customer code of the customer.
    Example: "1234567890"

  - `data.quickbooks_customer_id` (string,null)
    The Quickbooks customer ID of the customer.
    Example: "1234567890"

  - `meta` (object)
    Metadata about a paginated response.

  - `meta.total` (integer, required)
    Total number of records.
    Example: 50

  - `meta.per_page` (integer, required)
    Number of records per page.
    Example: 15

  - `meta.current_page` (integer, required)
    The current page.
    Example: 1

  - `meta.last_page` (integer, required)
    The last page of records.
    Example: 4

  - `meta.from` (integer,null)
    The ID of the first record on this page. This is specified as either integer or null purely for spec testing purposes. The model which is autogenerated from this definition will be thrown out and written by-hand.
    Example: 1

  - `meta.to` (integer,null)
    The ID of the last record on this page. This is specified as either integer or null purely for spec testing purposes. The model which is autogenerated from this definition will be thrown out and written by-hand.
    Example: 15

  - `meta.path` (string, required)
    The current paged path.
    Example: "https://api.aryeo.com/v1/{path}"

  - `meta.links` (array,null)
    Links.

  - `meta.links.url` (string,null, required)
    The URL of the page.
    Example: "https://admin.aryeo.test/api/v1/companies?page=2"

  - `meta.links.label` (string, required)
    The label of the page.
    Example: "2"

  - `meta.links.active` (boolean, required)
    Whether the page is active.
    Example: true

  - `meta.links.page` (integer,null)
    The page number this link points to.
    Example: 2

  - `links` (object)
    Related links for a paginated response.

  - `links.first` (string, required)
    The first page.
    Example: "https://api.aryeo.com/v1/{path}?page=1"

  - `links.last` (string, required)
    The last page.
    Example: "https://api.aryeo.com/v1/{path}?page=10"

  - `links.prev` (string,null)
    The previous page. This is specified as either string or null purely for spec testing purposes. The model which is autogenerated from this definition will be thrown out and written by-hand.
    Example: "https://api.aryeo.com/v1/{path}?page=2"

  - `links.next` (string,null)
    The next page. This is specified as either string or null purely for spec testing purposes. The model which is autogenerated from this definition will be thrown out and written by-hand.
    Example: "https://api.aryeo.com/v1/{path}?page=3"

  - `timestamp` (string,null)
    The request timestamp (ISO 8601).
    Example: "2021-06-30T20:30:00Z"

## Response 404 fields (application/json):

  - `status` (string, required)
    What was the state of the request?
    Example: "error"

  - `message` (string, required)
    The error message.
    Example: "{ApiError message.}"

  - `code` (integer,null)
    A numeric code corresponding to the error.
    Example: 404

## Response 422 fields (application/json):

  - `status` (string, required)
    What was the state of the request?
    Example: "fail"

## Response 500 fields (application/json):

  - `status` (string, required)
    What was the state of the request?
    Example: "error"

  - `message` (string, required)
    The error message.
    Example: "{ApiError message.}"

  - `code` (integer,null)
    A numeric code corresponding to the error.
    Example: 500