GET
/
api
/
extraction
/
v1
/
emails
curl --request GET \
  --url https://api.bspk.com/api/extraction/v1/emails \
  --header 'Authorization: Bearer <token>'
[
  {
    "store_id": "Store-external_id-51",
    "store_name": "Store-60",
    "sales_associate_id": "SA_01",
    "sales_associate_name": "FirstName-89 LastName-89",
    "client_id": "EXTERNAL_ID_156",
    "client_name": "FirstName-90 LastName-90",
    "template_id": "2",
    "template_name": "Test Template",
    "slice_id": null,
    "media": [],
    "created_at": "2024-08-07T12:29:24.731Z"
  }
]

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

Unique identifier of the store where the email originated from (based on associate assignment)

store_name
string | null
required

Store name of where the email originated from (based on associate assignment)

sales_associate_id
string
required

Unique identifier of the associate that created the email

sales_associate_name
string
required

Full name of the associate who created the email

client_id
string
required

Unique identifier of the client that the email was sent to

client_name
string
required

Full name of the client that the email was sent to

template_id
string | null
required

Unique identifier of the template that was used for the email

template_name
string | null
required

Name of the template that was used for the email

slice_id
string | 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 email was created