Get Customer

Get a customer

curl --request GET \
  --url https://api.bitbybit.studio/customer/api/open/v1/customers/{id} \
  --header 'x-api-key: <api-key>'

const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};

fetch('https://api.bitbybit.studio/customer/api/open/v1/customers/{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://api.bitbybit.studio/customer/api/open/v1/customers/{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 => [
    "x-api-key: <api-key>"
  ],
]);

$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.bitbybit.studio/customer/api/open/v1/customers/{id}"

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

	req.Header.Add("x-api-key", "<api-key>")

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

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

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.bitbybit.studio/customer/api/open/v1/customers/{id}")

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

request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'

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

{
  "data": {
    "id": "<string>",
    "email": "<string>",
    "phoneNumber": "<string>",
    "firstName": "<string>",
    "lastName": "<string>",
    "imageUrl": "<string>",
    "tags": [
      "<string>"
    ],
    "addresses": [
      {
        "id": "<string>",
        "firstName": "<string>",
        "lastName": "<string>",
        "phone": "<string>",
        "address1": "<string>",
        "address2": "<string>",
        "city": "<string>",
        "province": "<string>",
        "country": "<string>",
        "zip": "<string>"
      }
    ],
    "additionalData": {
      "favorite_food": "Nasi Goreng",
      "shirt_size": "L",
      "loyalty_signup_year": 2024
    },
    "subscriptionStatus": [
      {
        "app": "BITCRM",
        "status": "subscribe"
      }
    ],
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z"
  }
}

{
  "error": {
    "code": "NOT_FOUND",
    "message": "Resource not found"
  }
}

GET

customers

{id}

Get a customer

curl --request GET \
  --url https://api.bitbybit.studio/customer/api/open/v1/customers/{id} \
  --header 'x-api-key: <api-key>'

const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};

fetch('https://api.bitbybit.studio/customer/api/open/v1/customers/{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://api.bitbybit.studio/customer/api/open/v1/customers/{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 => [
    "x-api-key: <api-key>"
  ],
]);

$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.bitbybit.studio/customer/api/open/v1/customers/{id}"

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

	req.Header.Add("x-api-key", "<api-key>")

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

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

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.bitbybit.studio/customer/api/open/v1/customers/{id}")

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

request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'

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

{
  "data": {
    "id": "<string>",
    "email": "<string>",
    "phoneNumber": "<string>",
    "firstName": "<string>",
    "lastName": "<string>",
    "imageUrl": "<string>",
    "tags": [
      "<string>"
    ],
    "addresses": [
      {
        "id": "<string>",
        "firstName": "<string>",
        "lastName": "<string>",
        "phone": "<string>",
        "address1": "<string>",
        "address2": "<string>",
        "city": "<string>",
        "province": "<string>",
        "country": "<string>",
        "zip": "<string>"
      }
    ],
    "additionalData": {
      "favorite_food": "Nasi Goreng",
      "shirt_size": "L",
      "loyalty_signup_year": 2024
    },
    "subscriptionStatus": [
      {
        "app": "BITCRM",
        "status": "subscribe"
      }
    ],
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z"
  }
}

{
  "error": {
    "code": "NOT_FOUND",
    "message": "Resource not found"
  }
}

Returns the full profile for a single customer. Alongside the standard attributes, the response carries the customer’s additional data fields in additionalData and their per-app marketing subscription state in subscriptionStatus.

Additional data fields

additionalData is a flat map of field key to value. The keys are the field keys of the custom fields defined for your company in the Customers menu, so a field named “Favorite Food” with the key favorite_food is read as additionalData.favorite_food.

{
  "data": {
    "id": "cust_abc123",
    "email": "john@example.com",
    "firstName": "John",
    "lastName": "Doe",
    "tags": ["vip"],
    "additionalData": {
      "favorite_food": "Nasi Goreng",
      "shirt_size": "L",
      "loyalty_signup_year": 2024
    },
    "subscriptionStatus": [{ "app": "BITCRM", "status": "subscribe" }]
  }
}

Values keep the type they were stored with: text fields return strings, number fields return numbers, and multiple-choice fields return arrays. Fields synced from Shopify appear in the same map, alongside your bitbybit fields. A field the customer has never been given a value for is left out of the map, and a field that was set and later cleared comes back as null. Read keys defensively rather than assuming every field is present. A customer with no values at all returns "additionalData": {}.

additionalData is read-only here. Create and update calls do not accept it — set those values on the customer profile in the app, in the bitChat Additional data card, or through a bitLogin Collect Data form.

Subscription status

subscriptionStatus lists one entry per bitbybit app the customer has a recorded marketing preference for. app is BITCRM or BITLINK, and status is subscribe or unsubscribe. Apps with no recorded preference are omitted, so an empty array means the customer has never been opted in or out. The same two fields are also returned by List Customers.

Authorizations

x-api-key

string

header

required

API key for authentication. Create one in Settings > Developer.

Path Parameters

string

required

Response

Successful response

data

object

Show child attributes

Getting Started

Customers

Loyalty (bitLogin)

Loyalty (Customer)

Orders

Shipping

Products

Messaging

Analytics

Webhooks

Additional data fields

Subscription status

Authorizations

Path Parameters

Response

​Additional data fields

​Subscription status

Authorizations

Path Parameters

Response

Additional data fields

Subscription status