Skip to main content
GET
/
customers
List customers
curl --request GET \
  --url https://api.bitbybit.studio/customer/open/v1/customers \
  --header 'x-api-key: <api-key>'
{
  "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
  }
}

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

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