The Aryeo API provides access to the Aryeo platform.

Languages
Servers
Mock server

https://docs.aryeo.com/_mock/api/aryeo/

Production

https://api.aryeo.com/v1/

Addresses

Operations related to addresses.

Operations

Create address.

Request

Create address.

external: true
Bodyapplication/json

AddressPostPayload

latitudenumber or null[ -180 .. 180 ]required

The geographic latitude of some reference point of the location, specified in degrees and decimal parts. Positive numbers must not include the plus symbol.

Example: 42.35157458574123
longitudenumber or null[ -180 .. 180 ]required

The geographic longitude of some reference point of the location, specified in degrees and decimal parts. Positive numbers must not include the plus symbol.

Example: -71.05763741484657
street_numberstring or null[ 0 .. 255 ] characters

The street number portion of a location's address. In some areas, the street number may contain non-numeric characters. This field can also contain extensions and modifiers to the street number, such as '1/2' or '-B'.

Example: "107"
street_namestring or null[ 0 .. 255 ] characters

The street name portion of a location's address.

Example: "South St"
unit_numberstring or null[ 0 .. 255 ] characters

The number or portion of a larger building or complex. Examples are: 'APT G', '55', etc.

Example: "Unit 2F"
postal_codestring or null[ 0 .. 255 ] characters

The postal code portion of a location's address.

Example: "02111"
citystring or null[ 0 .. 255 ] characters

The city of a location's address.

Example: "Boston"
city_regionstring or null[ 0 .. 255 ] characters

A sub-section or area of a defined city. Examples would be SoHo in New York, NY, Ironbound in Newark, NJ or Inside the Beltway.

Example: "Leather District"
county_or_parishstring or null[ 0 .. 255 ] characters

The County, Parish or other regional authority of the location.

Example: "Suffolk County"
state_or_provincestring or null[ 0 .. 255 ] characters

The ISO 3166-2 subdivision code for the state or province of the location. For example, “MA” for Massachusetts, United States.

Example: "MA"
state_or_province_regionstring or null[ 0 .. 255 ] characters

A sub-section or area of a defined state or province. Examples would be the Keys in FL or Hudson Valley in NY.

Example: "Cape Cod"
countrystring or null[ 0 .. 255 ] characters

The ISO 3166-1 country code for this for the country of the location.

Example: "US"
country_regionstring or null[ 0 .. 255 ] characters

A sub-section or area of a defined country. Examples would be Napa Valley in the US, or the Amalfi Coast in Italy.

Example: "Napa Valley"
const resp = await fetch(
  `https://docs.aryeo.com/_mock/api/aryeo/addresses`,
  {
    method: 'POST',
    headers: {
      'Content-Type': 'application/json'
    },
    body: JSON.stringify({
      latitude: 42.35157458574123,
      longitude: -71.05763741484657,
      street_number: '107',
      street_name: 'South St',
      unit_number: 'Unit 2F',
      postal_code: '02111',
      city: 'Boston',
      city_region: 'Leather District',
      county_or_parish: 'Suffolk County',
      state_or_province: 'MA',
      state_or_province_region: 'Cape Cod',
      country: 'US',
      country_region: 'Napa Valley'
    })
  }
);

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

Responses

AddressResource

Bodyapplication/json
statusstring[ 0 .. 255 ] charactersrequired

What was the state of the request?

Example: "success"
dataobject(Address)

A street address and additional metadata about a location.

timestampstring or null(date-time)= 20 characters

The request timestamp (ISO 8601).

Example: "2021-06-30T20:30:00Z"
Response
application/json
{ "status": "success", "data": { "id": "00000000-0000-4000-8000-000000000000", "latitude": 42.35157458574123, "longitude": -71.05763741484657, "street_number": "107", "street_name": "South St", "unit_number": "Unit 2F", "postal_code": "02111", "city": "Boston", "city_region": "Leather District", "county_or_parish": "Suffolk County", "state_or_province": "MA", "state_or_province_region": "Cape Cod", "country": "US", "country_region": "Napa Valley", "timezone": "America/New_York", "unparsed_address": "107 South St, Boston MA, 02111", "unparsed_address_part_one": "107 South St, Unit 2F", "unparsed_address_part_two": "Boston, MA 02111", "is_map_dirty": true }, "timestamp": "2021-06-30T20:30:00Z" }

Get address.

Request

Get address.

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

The ID of an address. UUID Version 4.

Example: 00000000-0000-4000-8000-000000000000
const address = '00000000-0000-4000-8000-000000000000';
const resp = await fetch(
  `https://docs.aryeo.com/_mock/api/aryeo/addresses/${address}`,
  {method: 'GET'}
);

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

Responses

200

Bodyapplication/json
object
Response
application/json
{}

Update address.

Request

Update address.

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

The ID of an address. UUID Version 4.

Example: 00000000-0000-4000-8000-000000000000
const address = '00000000-0000-4000-8000-000000000000';
const resp = await fetch(
  `https://docs.aryeo.com/_mock/api/aryeo/addresses/${address}`,
  {method: 'PATCH'}
);

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

Responses

200

Bodyapplication/json
object
Response
application/json
{}

Appointments

Operations related to appointments.

Operations

Discounts

Operations related to discounts.

Operations

Listings

Operations related to listings.

Operations

Notes

Operations related to notes.

Operations

Order Forms

Operations related to order forms.

Operations

Order Items

Operations related to order items.

Operations

Orders

Operations related to orders.

Operations

Payroll

Operations related to payroll.

Operations

Products

Operations related to products.

Operations

Scheduling

Operations related to scheduling.

Operations

Tags

Operations related to tags.

Operations

Tasks

Operations related to tasks.

Operations

Users

Operations related to users.

Operations

Videos

Operations related to videos.

Operations