Skip to main content
GET
/
api
/
extraction
/
v1
/
slices
List Slices
curl --request GET \
  --url https://api.bspk.com/api/extraction/v1/slices \
  --header 'Authorization: Bearer <token>'
[
  {
    "store_id": "<string>",
    "store_name": "<string>",
    "created_by_sales_associate_id": "<string>",
    "created_by_sales_associate_name": "<string>",
    "title": "<string>",
    "body": "<string>",
    "created_at": "<string>",
    "updated_at": "<string>",
    "item_ids": [
      "<string>"
    ]
  }
]

Authorizations

​
Authorization
string
header
required

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

Query Parameters

​
sales_associate_ids
string

Sales Associate id owned by the brand

​
from
string

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

​
store_id
string
required

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

​
store_name
string
required

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

​
created_by_sales_associate_id
string
required

Unique identifier of the associate that created the slice

​
created_by_sales_associate_name
string
required

Full name of the associate who created the slice

​
title
string | null
required

Short description of the slice added by the original associate

​
body
string | null
required

Details added to the slice by the original associate

​
created_at
string<date_time>
required

Timestamp of when the slice was created

​
updated_at
string<date_time>
required

Timestamp of when the slice was last updated

​
item_ids
string[]
required

Unique identifiers of the items that were included in the slice