JUjumpseller
Appointments

Retrieve all Appointments.

Changed on

Returns store appointments, ordered by start date and time in descending order. Use fields to select response fields. start_date and end_date form an inclusive interval over the start date to filter appointments; either boundary may be used on its own. Dates and returned timeslots use the store timezone.

get/appointments.json

Request

  • Base URL
    https://api.jumpseller.com/v1
  • URL
    https://api.jumpseller.com/v1/appointments.json
  • Auth
    • HTTP basic
    • or API key in query parameter login and API key in query parameter authtoken
    • or OAuth 2
      Authorization code: https://accounts.jumpseller.com/oauth/authorize
      Token URL: https://accounts.jumpseller.com/oauth/token scopes: read_orders

Query parameters

limitinteger

Number of objects per page (maximum 100).

pageinteger

Page number, starting at 1.

fieldsstring
Example:id,status,timeslot

Comma-separated appointment fields to include in each response.

status'created' | 'voided' | 'canceled' | 'pending' | 'booked' | 'completed'
Example:booked

Filter by appointment status.

product_idinteger

Filter by appointment product id.

customer_idinteger

Filter by customer id.

start_datestring date
Example:2026-08-26

Inclusive lower boundary for the appointment start date.

end_datestring date
Example:2026-08-31

Inclusive upper boundary for the appointment start date.

Response

An array of appointments.

Changes

  • 53dc9f2c1329Revision changes
    • breaking

      the query request parameter status was restricted to a list of enum values

    • breaking

      the response property // became nullable for the status

    • warning

      for the query request parameter limit, the min was set to 1.00

    • warning

      for the query request parameter page, the min was set to 1.00

    • warning

      added the new booked enum value to the // response property for the response status

    • warning

      added the new canceled enum value to the // response property for the response status

    • warning

      added the new completed enum value to the // response property for the response status

    • warning

      added the new created enum value to the // response property for the response status

    • warning

      added the new pending enum value to the // response property for the response status

    • warning

      added the new voided enum value to the // response property for the response status

    • info

      added the new enum value booked to the query request parameter status

    • info

      added the new enum value canceled to the query request parameter status

    • info

      added the new enum value completed to the query request parameter status

    • info

      added the new enum value created to the query request parameter status

    • info

      added the new enum value pending to the query request parameter status

    • info

      added the new enum value voided to the query request parameter status

    • info

      for the query request parameter limit, the format was generalized from integer to no format

    • info

      for the query request parameter page, the format was generalized from integer to no format

  • 42f316fe2455Revision changes
    • info

      endpoint added