GET
/
api
/
extraction
/
v1
/
appointments
curl --request GET \
  --url https://api.bspk.com/api/extraction/v1/appointments \
  --header 'Authorization: Bearer <token>'
[
  {
    "store_id": "Store-external_id-44",
    "store_name": "Store-53",
    "sales_associate_id": "SA_01",
    "sales_associate_name": "FirstName-75 LastName-75",
    "client_id": "CL_01",
    "client_name": "FirstName-76 LastName-76",
    "title": "Some title",
    "body": "Some notes\n here.",
    "starts_at": "2024-08-08T00:00:00.000Z",
    "ends_at": null,
    "is_done": false,
    "is_done_at": null,
    "notes": "Some notes\n here.",
    "created_at": "2024-08-07T12:29:22.984Z",
    "updated_at": "2024-08-07T12:29:22.984Z"
  }
]

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

​
client_ids
string

Client id owned by the brand

​
sales_associate_ids
string

Sales Associate id owned by the brand

​
from
string

Only show appointments updated after the given time. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

​
to
string

Combined with the from parameter, only show appointments updated whitin the given range (from..to) time. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

​
page
string

Page number of the results to fetch. Default: 1

​
per_page
string

Results per page (max 100). Default: 30

Response

200 - application/json
Successful response, returns array of appointments
​
store_id
string
required

Unique identifier of the store where the appointment was created (based on associate assignment)

​
store_name
string | null
required

Store name of where the appointment was created (based on associate assignment)

​
sales_associate_id
string
required

Unique identifier of the associate that created the appointment

​
sales_associate_name
string
required

Full name of the associate who created the appointment

​
client_id
string
required

Unique identifier of the client that the appointment is with

​
client_name
string
required

Full name of the client that the appointment is with

​
title
string | null
required

Short description of the appointment added by the associate

​
body
string | null
required

TODO: Details added to the appointment by the associate

​
created_at
string
required

Timestamp of when the appointment was created

​
updated_at
string
required

Timestamp of when the appointment was last updated

​
starts_at
string
required

Timestamp of when the appointment was scheduled to start

​
ends_at
string | null
required

Timestamp of when the appointment was scheduled to end

​
is_done
boolean
required

Whether or not the appointment was marked as done by the associate. If the appointment is marked as done this will be true, otherwise defaults to false

​
is_done_at
string | null
required

Timestamp of when the appointment was marked as done by the associate