Skip to main content
GET
/
v1
/
customers
Get Customers
curl --request GET \
  --url https://api.trykintsugi.com/v1/customers \
  --header 'X-API-KEY: <api-key>' \
  --header 'x-organization-id: <api-key>'
{
  "items": [
    {
      "id": "cust_123abc",
      "organization_id": "org_456xyz",
      "name": "John Doe",
      "external_id": "cust_123",
      "status": "ACTIVE",
      "email": "john.doe@example.com",
      "phone": "+1234567890",
      "street_1": "123 Main Street",
      "street_2": "Apt 4B",
      "city": "San Francisco",
      "county": "San Francisco County",
      "state": "CA",
      "postal_code": "94105",
      "country": "US",
      "full_address": "123 Main Street, Apt 4B, San Francisco, CA 94105",
      "source": "BIGCOMMERCE",
      "connection_id": "conn_12345",
      "address_status": "UNVERIFIED",
      "external_friendly_id": "1234567890"
    }
  ],
  "total": 1,
  "page": 1,
  "size": 50,
  "pages": 1
}

Authorizations

​
X-API-KEY
string
header
required
​
x-organization-id
string
header
required

Query Parameters

​
search_query
string

Search term to filter customers by name or other details

​
country
enum<string>[]

Country code in ISO 3166-1 alpha-2 format (e.g., 'US')

Available options:
AF,
AX,
AL,
DZ,
AS,
AD,
AO,
AI,
AQ,
AG,
AR,
AM,
AW,
AU,
AT,
AZ,
BS,
BH,
BD,
BB,
BY,
BE,
BZ,
BJ,
BM,
BT,
BO,
BQ,
BA,
BW,
BV,
BR,
IO,
BN,
BG,
BF,
BI,
CV,
KH,
CM,
CA,
KY,
CF,
TD,
CL,
CN,
CX,
CC,
CO,
KM,
CG,
CD,
CK,
CR,
HR,
CU,
CW,
CY,
CZ,
DK,
DJ,
DM,
DO,
EC,
EG,
SV,
GQ,
ER,
EE,
SZ,
ET,
FK,
FO,
FJ,
FI,
FR,
GF,
PF,
TF,
GA,
GM,
GE,
DE,
GH,
GI,
GR,
GL,
GD,
GP,
GU,
GT,
GG,
GN,
GW,
GY,
HT,
HM,
VA,
HN,
HK,
HU,
IS,
IN,
ID,
IR,
IQ,
IE,
IM,
IL,
IT,
CI,
JM,
JP,
JE,
JO,
KZ,
KE,
KI,
KP,
KR,
KW,
KG,
LA,
LV,
LB,
LS,
LR,
LY,
LI,
LT,
LU,
MO,
MG,
MW,
MY,
MV,
ML,
MT,
MH,
MQ,
MR,
MU,
YT,
MX,
FM,
MD,
MC,
MN,
ME,
MS,
MA,
MZ,
MM,
NA,
NR,
NP,
NL,
NC,
NZ,
NI,
NE,
NG,
NU,
NF,
MK,
MP,
NO,
OM,
PK,
PW,
PS,
PA,
PG,
PY,
PE,
PH,
PN,
PL,
PT,
PR,
QA,
RE,
RO,
RU,
RW,
BL,
SH,
KN,
LC,
MF,
PM,
VC,
WS,
SM,
ST,
SA,
SN,
RS,
SC,
SL,
SG,
SX,
SK,
SI,
SB,
SO,
ZA,
GS,
SS,
ES,
LK,
SD,
SR,
SJ,
SE,
CH,
SY,
TW,
TJ,
TZ,
TH,
TL,
TG,
TK,
TO,
TT,
TN,
TR,
TM,
TC,
TV,
UG,
UA,
AE,
GB,
US,
UM,
UY,
UZ,
VU,
VE,
VN,
VG,
VI,
WF,
EH,
YE,
ZM,
ZW,
XK,
ZZ_EU
​
state
string

State or province code to filter customers

​
source__in
string

Filter customers by source (comma-separated)

​
order_by
string

Comma-separated list of fields to sort results by.

​
page
integer
default:1

Page number

Required range: x >= 1
​
size
integer
default:50

Page size

Required range: 1 <= x <= 100

Response

Successfully retrieved customers

​
items
CustomerRead · object[]
required
​
total
integer
required
Required range: x >= 0
​
page
integer
required
Required range: x >= 1
​
size
integer
required
Required range: x >= 1
​
pages
integer
required
Required range: x >= 0