GET
/
api
/
extraction
/
v1
/
messages
curl --request GET \
  --url https://api.bspk.com/api/extraction/v1/messages \
  --header 'Authorization: Bearer <token>'
[]

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 messages 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 messages 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 messages
store_id
string
required

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

store_name
string | null
required

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

sales_associate_id
string
required

Unique identifier of the associate that created the message

sales_associate_name
string
required

Full name of the associate who created the message

client_id
string
required

Unique identifier of the client that the message is to

client_name
string
required

Full name of the client that the message is to

body
string | null
required

The text included in the message

channel
string
required

The channel in which the message was sent from

template_id
string | null
required

Unique identifier of the template that was used for the message

template_name
string | null
required

Name of the template that was used for the message

slice_id
integer | null
required

Unique identifier of the Slice that was include in the email (if any)

media
object[]
required
created_at
string
required

Timestamp of when the message was created