GET
/
api
/
extraction
/
v1
/
notes
List Notes
curl --request GET \
  --url https://api.bspk.com/api/extraction/v1/notes \
  --header 'Authorization: Bearer <token>'
[
  {
    "store_id": "Store-external_id-56",
    "store_name": "Store-65",
    "sales_associate_id": "SA_01",
    "sales_associate_name": "FirstName-102 LastName-102",
    "client_id": "EXTERNAL_ID_174",
    "client_name": "FirstName-103 LastName-103",
    "body": "Test notes",
    "media": [],
    "created_at": "2024-08-07T12:29:26.577Z"
  }
]

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, supply

​
sales_associate_ids
string

Sales Associate id owned by the brand

​
from
string

Only show notes 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 notes 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 notes

​
store_id
string
required

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

​
store_name
string | null
required

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

​
sales_associate_id
string
required

Unique identifier of the associate that created the note

​
sales_associate_name
string
required

Full name of the associate who created the note

​
client_id
string
required

Unique identifier of the client that the note was for

​
client_name
string
required

Full name of the client that the note was for

​
body
string
required

The text included in the note

​
media
object[]
required
​
created_at
string<date_time>
required

Timestamp of when the note was created