Locations

Bases of operation.

5 endpoints · base URL https://api.aerscheduler.com

get/locations

List locations

Every location in your organization.

Query parameters

`limit`	`integer`	Rows to return, 1,1000. Defaults to 1000; a larger value is clamped rather than rejected.
`offset`	`integer`	Rows to skip, for paging. Defaults to 0.
`sort`	`string`	Field to order by before paging, as a dot path into the row , `total`, `user.firstName`. Omit to keep the endpoint's own order. Numbers and ISO timestamps order as numbers and instants, not as text, and empty values always sort last regardless of direction. Ordering happens before the page is cut, so it orders the whole collection rather than the page you are holding.
`order`	`"asc" \| "desc"`	`asc` (default) or `desc`. Only meaningful with `sort`.

Responses

`200`	OK	The locations.→ { data: Location[] }
`401`	Unauthorized	No token, an expired token, or a malformed one. Sign in again.
`403`	Forbidden	Authenticated, but not allowed to do this.
`429`	Too Many Requests	Rate limited. `Retry-After` says how long to wait.

Example request

curl https://api.aerscheduler.com/locations \
  -H "Authorization: Bearer $AERSCHEDULER_KEY"

post/locations

Create a location

Adds a location to your organization. Requires the admin role.

Request body

The new location. Picking a published airport should send its ident and coordinates. A typed site can omit both. The address is stored as entered.

`name`required	`string`
`ident`	`string \| null`	ICAO when the field has one (`KAPA`), otherwise the FAA local code. Optional.
`timeZone`	`string \| null`
`address`	`Address`
`coordinates`	`object`

Responses

`201`	Created	The location that was created.→ { data: Location }
`400`	Bad Request	The body failed validation. `message` says which field.
`401`	Unauthorized	No token, an expired token, or a malformed one. Sign in again.
`403`	Forbidden	Authenticated, but not allowed to do this.
`429`	Too Many Requests	Rate limited. `Retry-After` says how long to wait.

Example request

curl -X POST https://api.aerscheduler.com/locations \
  -H "Authorization: Bearer $AERSCHEDULER_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name":"…"}'

get/locations/{id}

Get a location

Fetches one location by id.

Path parameters

idrequired integer The location id.

Responses

`200`	OK	Success.→ { data: Location }
`401`	Unauthorized	No token, an expired token, or a malformed one. Sign in again.
`403`	Forbidden	Authenticated, but not allowed to do this.
`404`	Not Found	No such location, or it belongs to another organization.
`429`	Too Many Requests	Rate limited. `Retry-After` says how long to wait.

Example request

curl https://api.aerscheduler.com/locations/:id \
  -H "Authorization: Bearer $AERSCHEDULER_KEY"

patch/locations/{id}

Update a location

Changes the fields you send and leaves the rest alone. Requires the admin role.

Path parameters

idrequired integer The location id.

Request body

Fields to change. Omitting ident leaves the stored identifier alone; send null to clear it. Same rule for timeZone. Omitting coordinates leaves the stored position alone.

`name`	`string`
`ident`	`string \| null`
`timeZone`	`string \| null`
`address`	`Address`
`coordinates`	`object`

Responses

`200`	OK	The updated location.→ { data: Location }
`400`	Bad Request	The body failed validation.
`401`	Unauthorized	No token, an expired token, or a malformed one. Sign in again.
`403`	Forbidden	Authenticated, but not allowed to do this.
`429`	Too Many Requests	Rate limited. `Retry-After` says how long to wait.

Example request

curl -X PATCH https://api.aerscheduler.com/locations/:id \
  -H "Authorization: Bearer $AERSCHEDULER_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name":"…","ident":"…"}'

delete/locations/{id}

Delete a location

Removes the location. Requires the admin role.

Path parameters

idrequired integer The location id.

Responses

`204`	No Content	Success. No body.
`400`	Bad Request	The location could not be deleted , usually because something still references it.
`401`	Unauthorized	No token, an expired token, or a malformed one. Sign in again.
`403`	Forbidden	Authenticated, but not allowed to do this.
`429`	Too Many Requests	Rate limited. `Retry-After` says how long to wait.

Example request

curl -X DELETE https://api.aerscheduler.com/locations/:id \
  -H "Authorization: Bearer $AERSCHEDULER_KEY"

PreviousInvoicesBilling for completed flights.NextGroupsSets of members or resources.

API overview Talk to us