Skip to main content
GET
/
customers
List customers
curl --request GET \
  --url https://api.bitbybit.studio/customer/api/open/v1/customers \
  --header 'x-api-key: <api-key>'
import requests

url = "https://api.bitbybit.studio/customer/api/open/v1/customers"

headers = {"x-api-key": "<api-key>"}

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

print(response.text)
const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};

fetch('https://api.bitbybit.studio/customer/api/open/v1/customers', 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",
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"

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))

}
HttpResponse<String> response = Unirest.get("https://api.bitbybit.studio/customer/api/open/v1/customers")
.header("x-api-key", "<api-key>")
.asString();
require 'uri'
require 'net/http'

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

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>"
        }
      ],
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z"
    }
  ],
  "meta": {
    "page": 123,
    "limit": 123,
    "total": 123,
    "hasNextPage": true
  }
}
{
"error": {
"code": "INVALID_API_KEY",
"message": "Invalid or expired API key"
}
}
{
"error": {
"code": "RATE_LIMIT_EXCEEDED",
"message": "Too many requests. Please retry after the reset period."
}
}

Authorizations

x-api-key
string
header
required

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

Query Parameters

page
integer
default:1

Page number

Required range: x >= 1
limit
integer
default:20

Number of results per page

Required range: 1 <= x <= 100

Search by name, email, or phone number

source
string

Filter by source values (comma-separated)

tags
string

Filter by tags (comma-separated)

sort
string
default:updatedAt:desc

Sort field and direction (e.g., updatedAt:desc)

Response

Successful response

data
object[]
meta
object