List Clients

List Clients

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

import requests

url = "https://api.bspk.com/api/extraction/v1/clients"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.bspk.com/api/extraction/v1/clients', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.bspk.com/api/extraction/v1/clients",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.bspk.com/api/extraction/v1/clients"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.bspk.com/api/extraction/v1/clients")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.bspk.com/api/extraction/v1/clients")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

[
  {
    "bspk_id": 12345,
    "current_sales_associate_id": "SA_01",
    "current_sales_associate_name": "FirstName-84 LastName-84",
    "current_store_id": null,
    "current_store_name": null,
    "client_id": "EXTERNAL_ID_150",
    "name": "FirstName-85 LastName-85",
    "first_name": "FirstName-85",
    "last_name": "LastName-85",
    "email": "someone92@example.com",
    "mobile_phone": "+14153400067",
    "other_phone": "+14153400067",
    "birthday": null,
    "gender": null,
    "nationality": null,
    "passport_number": null,
    "language": null,
    "title": null,
    "address": "",
    "addresses": [
      {
        "address": null,
        "address_2": null,
        "address_3": null,
        "address_4": null,
        "city": null,
        "state": null,
        "zip": null,
        "country_code": null
      }
    ],
    "preferred_contact_channel": null,
    "communication_preferences": {
      "chat_opt_in": true,
      "email_opt_in": true,
      "phone_opt_in": true,
      "whatsapp_opt_in": false,
      "wechat_opt_in": false,
      "line_opt_in": false,
      "opt_out": false
    },
    "preferences": [],
    "interests": [],
    "preferred_journey": null,
    "segment": null,
    "referred_by_client_id": null,
    "referred_at": null,
    "consent": false,
    "notify_of_new_collection": false,
    "last_contacted_at": "2024-08-02T12:29:24.068Z",
    "created_at": "2024-08-07T12:29:24.099Z",
    "updated_at": "2024-08-07T12:29:24.099Z"
  }
]

GET

api

extraction

clients

List Clients

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

import requests

url = "https://api.bspk.com/api/extraction/v1/clients"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.bspk.com/api/extraction/v1/clients', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.bspk.com/api/extraction/v1/clients",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.bspk.com/api/extraction/v1/clients"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.bspk.com/api/extraction/v1/clients")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.bspk.com/api/extraction/v1/clients")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

[
  {
    "bspk_id": 12345,
    "current_sales_associate_id": "SA_01",
    "current_sales_associate_name": "FirstName-84 LastName-84",
    "current_store_id": null,
    "current_store_name": null,
    "client_id": "EXTERNAL_ID_150",
    "name": "FirstName-85 LastName-85",
    "first_name": "FirstName-85",
    "last_name": "LastName-85",
    "email": "someone92@example.com",
    "mobile_phone": "+14153400067",
    "other_phone": "+14153400067",
    "birthday": null,
    "gender": null,
    "nationality": null,
    "passport_number": null,
    "language": null,
    "title": null,
    "address": "",
    "addresses": [
      {
        "address": null,
        "address_2": null,
        "address_3": null,
        "address_4": null,
        "city": null,
        "state": null,
        "zip": null,
        "country_code": null
      }
    ],
    "preferred_contact_channel": null,
    "communication_preferences": {
      "chat_opt_in": true,
      "email_opt_in": true,
      "phone_opt_in": true,
      "whatsapp_opt_in": false,
      "wechat_opt_in": false,
      "line_opt_in": false,
      "opt_out": false
    },
    "preferences": [],
    "interests": [],
    "preferred_journey": null,
    "segment": null,
    "referred_by_client_id": null,
    "referred_at": null,
    "consent": false,
    "notify_of_new_collection": false,
    "last_contacted_at": "2024-08-02T12:29:24.068Z",
    "created_at": "2024-08-07T12:29:24.099Z",
    "updated_at": "2024-08-07T12:29:24.099Z"
  }
]

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 clients updated after the given time. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

string

Combined with the from parameter, only show clients 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 clients

bspk_id

integer

required

BSPK internal unique identifier of the client

client_id

string

required

Unique identifier of the client

name

string | null

required

deprecated

Full name of the client

title

string | null

required

Title of the client

address

string | null

required

deprecated

Address of the client consolidated

addresses

object[]

required

Show child attributes

string | null

required

Email of the client

mobile_phone

string | null

required

Mobile phone of the client

other_phone

string | null

required

Other phone of the client

birthday

string<date_time> | null

required

Birthday of the client

gender

enum<string> | null

required

Gender of the client

Available options:

M,

F,

NB,

null

nationality

string | null

required

Nationality of the client

passport_number

string | null

required

Passport Number of the client

language

string | null

required

Language of the client

preferred_contact_channel

enum<string> | null

required

The preferred channel of the client

Available options:

chat,

email,

line,

whastapp,

wechat,

call,

null

current_sales_associate_id

string | null

required

Unique identifier of the associate that the client is assigned to

current_sales_associate_name

string | null

required

Full name of the associate that the client is assigned to

current_store_id

string | null

required

Unique identifier of the store that the client is assigned to

current_store_name

string | null

required

Name of the store that the client is assigned to

communication_preferences

object

required

Show child attributes

preferences

object[]

required

Show child attributes

segment

string | null

required

The Segmentention which the client is assigned to

preferred_journey

string | null

required

The Journey which the client is assigned to

referred_by_client_id

string | null

required

Unique identifier of the client that referred this client

referred_at

string | null

required

The date when the client referral was recorded in BSPK

Whether or not the client has given consent

notify_of_new_collection

boolean

required

Whether or not the client wants to be notified of new collections

last_contacted_at

string<date_time> | null

required

The last date the client was contacted by a Sales Associate

created_at

string<date_time>

required

Timestamp of when the client was created

updated_at

string<date_time>

required

Timestamp of when the client was updated

first_name

string | null

First name of the client

last_name

string | null

Last name of the client

List Calls List Emails

Using the API

Platform API

Extraction API

Clients

Shoppers

Shopper Metafields

Shopper Addresses

Products

Webhooks

Authorizations

Query Parameters

Response