Skip to main content
GET
/
v2
/
customer_sessions
/
{session_id}
Retrieve a session
curl --request GET \
  --url https://dev.sbx.imprint.co/v2/customer_sessions/{session_id} \
  --header 'Authorization: Basic <encoded-value>'
import requests

url = "https://dev.sbx.imprint.co/v2/customer_sessions/{session_id}"

headers = {"Authorization": "Basic <encoded-value>"}

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

print(response.text)
const options = {method: 'GET', headers: {Authorization: 'Basic <encoded-value>'}};

fetch('https://dev.sbx.imprint.co/v2/customer_sessions/{session_id}', 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://dev.sbx.imprint.co/v2/customer_sessions/{session_id}",
  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: Basic <encoded-value>"
  ],
]);

$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://dev.sbx.imprint.co/v2/customer_sessions/{session_id}"

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

	req.Header.Add("Authorization", "Basic <encoded-value>")

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

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

	fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.get("https://dev.sbx.imprint.co/v2/customer_sessions/{session_id}")
  .header("Authorization", "Basic <encoded-value>")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://dev.sbx.imprint.co/v2/customer_sessions/{session_id}")

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Basic <encoded-value>'

response = http.request(request)
puts response.read_body
{
  "id": "2EE24580-B97B-4949-A65C-929CCB9B9B8D",
  "client_secret": "QzMyNzg4QzgtNEUwOS00QkU4LThDMjEtMkU5OUQ3QzkwRDhGCg==",
  "expires_at": "2025-02-13T19:08:07.000Z",
  "metadata": {
    "store_number": "123"
  },
  "customer_metadata": {
    "loyalty_id": "840012345678",
    "membership_tier": "gold"
  },
  "source": "web_signup"
}
{
  "type": "SESSION_NOT_FOUND_ERROR",
  "message": "Session not found for provided ID: cs_123",
  "param": "session_id"
}

Authorizations

​
Authorization
string
header
required

Basic HTTP authentication. Allowed headers-- Authorization: Basic <base64(api_key_id:api_key_secret)>

Path Parameters

​
session_id
string
required

Response

Customer session retrieved successfully

Represents a session created on behalf of an Imprint customer

​
id
string
required

The unique ID Imprint assigns to the session.

Example:

"2EE24580-B97B-4949-A65C-929CCB9B9B8D"

​
client_secret
string
required

Not to be logged or stored. Provide this one time use token to the Imprint SDK or other client side code to allow the customer access to edit their own account or apply

Example:

"QzMyNzg4QzgtNEUwOS00QkU4LThDMjEtMkU5OUQ3QzkwRDhGCg=="

​
expires_at
string
required

the RFC-3339 timestamp when the client_secret will expire.

Example:

"2025-02-13T19:08:07.000Z"

​
metadata
object

Set of key-value pairs for storing additional information about the customer session.

Example:
{ "store_number": "123" }
​
customer_metadata
object

A set of key-value pairs attached to the customer. These values will be included in webhook event payloads for the partner to receive information about the customer.

Example:
{
  "loyalty_id": "840012345678",
  "membership_tier": "gold"
}
​
source
string

The source where the session was initiated

Example:

"web_signup"