Appointments

Retrieve an Appointment.

Changed on

Returns a single appointment by id. Use fields to select response fields.

get/appointments/{id}.json

Request

  • Base URL
    https://api.jumpseller.com/v1
  • URL
    https://api.jumpseller.com/v1/appointments/{id}.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

Path parameters

idinteger required

Id of the appointment.

Query parameters

fieldsstring
Example:id,status,timeslot

Comma-separated appointment fields to include in the response.

Response

Appointment retrieved successfully.

Changes

    • breaking

      the response property / became nullable for the status

    • 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

      endpoint added