REST API

Customers API

Use the Sky Schedule customers API to list and fetch the students and renters on your school's roster, with name, email, phone, and active or inactive status.

llms.txt

The customers API returns the students and renters on your school's roster: the people booked as the customer on a reservation. Each record has a name, email, phone number, and whether the customer is active. Use it to sync your roster to a mailing list, a spreadsheet, or another system.

Method and pathDescription
GET/api/v1/customersList customers
GET/api/v1/customers/{id}Get one customer by id

The customer object

FieldTypeDescription
idstring (UUID)Customer id.
namestring or nullFull name.
emailstring or nullEmail address.
phonestring or nullPhone number as entered.
statusstringactive or inactive.

List customers

GET https://app.skyschedule.io/api/v1/customers

Query parameters

ParameterRequiredDescription
limitNoRecords to return, 1 to 100. Default 50.

Customers are sorted by name, A to Z, and both active and inactive customers are included. There is no offset or search parameter, so one request returns at most the first 100 customers alphabetically. If your school has more than 100, the list won't reach the end of the alphabet.

Example request

curl -s "https://app.skyschedule.io/api/v1/customers?limit=2" \
  -H "Authorization: Bearer $SKYSCHEDULE_API_KEY"

Example response

{
  "data": [
    {
      "id": "44444444-4444-4444-8444-444444444444",
      "name": "Alex Student",
      "email": "alex.student@example.com",
      "phone": "555-0100",
      "status": "active"
    },
    {
      "id": "55555555-5555-4555-8555-555555555555",
      "name": "Blair Renter",
      "email": "blair.renter@example.com",
      "phone": null,
      "status": "inactive"
    }
  ],
  "meta": {
    "count": 2,
    "pageSize": 2,
    "rateLimit": { "limit": 100, "remaining": 93, "reset": "2026-10-09T00:00:00.000Z" }
  }
}

Get one customer

GET https://app.skyschedule.io/api/v1/customers/{id}

curl -s "https://app.skyschedule.io/api/v1/customers/44444444-4444-4444-8444-444444444444" \
  -H "Authorization: Bearer $SKYSCHEDULE_API_KEY"

{
  "data": {
    "id": "44444444-4444-4444-8444-444444444444",
    "name": "Alex Student",
    "email": "alex.student@example.com",
    "phone": "555-0100",
    "status": "active"
  },
  "meta": {
    "rateLimit": { "limit": 100, "remaining": 92, "reset": "2026-10-09T00:00:00.000Z" }
  }
}

An id that doesn't exist in your school returns 404 with { "error": "Customer not found." }.

Matching customers to reservations and flights

Reservations and completed flights include the customer's name, email, and phone, but not the customer id. Match records on email.

The customer list holds personal information. Keep the API key and anything you store from it private, as described in API authentication.

PreviousCompleted flightsNextInstructors