- Explore demo
- Speak to an expert
- Changelog
- Blog
Account
Billing
Collections
Customers
Invoices
Notifications & Webhooks
Product
Seats
Taxes
Usage
Version 2024-01-01
Version 2024-05-09
Latest API
All API versions
List Customers
List all Customers.
Your API credentials. Eg. Basic {credentials}.
Sort column. Default: creation time.
Filter by legal name
Filter by email
Filter by alias
Include archived customers
Pagination cursor. To page through items, omit this parameter to retrieve the first page, and then successively use the value you get from pagination.after or pagination.before to retrieve each page.
Pagination cursor. To page through items, omit this parameter to retrieve the first page, and then successively use the value you get from pagination.after or pagination.before to retrieve each page.
Maximum number of objects to return per-page.
Sort order. Default: DESC (descending, most often used for reverse chronological sorting).
curl --request GET \
--url https://eu.sequencehq.com/api/customers \
--header 'Authorization: <authorization>'{
"items": [
{
"id": "e309e948-088e-4d77-b654-cd85498f1555",
"createdAt": "2022-06-28T16:47:00Z",
"legalName": "John Doe",
"contactName": "John Doe",
"address": {
"line1": "Flat 1",
"line2": "123 Fake Street",
"town": "New York",
"state": "NY",
"postcode": "AB1 2EF",
"country": "US"
},
"email": "john@example.com",
"telephone": "02010001000",
"url": "https://example.com/",
"label": "Example customer",
"integrationIds": [
{
"service": "Xero",
"id": "ID",
"lastSynced": "2022-06-28T16:47:00Z"
},
{
"service": "Stripe",
"id": "cus_OCtCxqQDgu1uX9",
"lastSynced": "2022-06-28T16:47:00Z"
}
],
"archivedAt": "2022-06-28T16:47:00Z",
"billingEmails": [
"exampleCorpInvoices@example.com"
],
"taxStatus": "TAXED"
}
],
"pagination": {
"after": "MDE4NDUyNjYtNmQ2NC03N2M4LTlhZGYtNDQ4N2Q5NGQxNDU3",
"before": "MDE4NDQyMWUtYTljYy03MTFiLWFmOTMtYmYwNTExZDRkODMz",
"totalResultSize": 10
}
}Headers
Your API credentials. Eg. Basic {credentials}.
Query Parameters
Sort column. Default: creation time.
Filter by legal name
Filter by email
Filter by alias
Include archived customers
Pagination cursor. To page through items, omit this parameter to retrieve the first page, and then successively use the value you get from pagination.after or pagination.before to retrieve each page.
Pagination cursor. To page through items, omit this parameter to retrieve the first page, and then successively use the value you get from pagination.after or pagination.before to retrieve each page.
Maximum number of objects to return per-page.
Sort order. Default: DESC (descending, most often used for reverse chronological sorting).
Response
Customers
Unique ID
Created at
Legal name
Contact Name
Address
Address line 1
Address line 2
Town or city
State (required for USA only)
AL, AK, AZ, AR, CA, CO, CT, DC, DE, FL, GA, HI, ID, IL, IN, IA, KS, KY, LA, ME, MD, MA, MI, MN, MS, MO, MT, NE, NV, NH, NJ, NM, NY, NC, ND, OH, OK, OR, PA, RI, SC, SD, TN, TX, UT, VT, VA, WA, WV, WI, WY, AB, BC, MB, NB, NL, NS, ON, PE, QC, SK Postal code
Country code (ISO 3166-1 alpha-2)
AD, AE, AF, AG, AI, AL, AM, AO, AQ, AR, AS, AT, AU, AW, AX, AZ, BA, BB, BD, BE, BF, BG, BH, BI, BJ, BL, BM, BN, BO, BQ, BR, BS, BT, BV, BW, BY, BZ, CA, CC, CD, CF, CG, CH, CI, CK, CL, CM, CN, CO, CR, CU, CV, CW, CX, CY, CZ, DE, DJ, DK, DM, DO, DZ, EC, EE, EG, EH, ER, ES, ET, FI, FJ, FK, FM, FO, FR, GA, GB, GD, GE, GF, GG, GH, GI, GL, GM, GN, GP, GQ, GR, GS, GT, GU, GW, GY, HK, HM, HN, HR, HT, HU, ID, IE, IL, IM, IN, IO, IQ, IR, IS, IT, JE, JM, JO, JP, KE, KG, KH, KI, KM, KN, KP, KR, KW, KY, KZ, LA, LB, LC, LI, LK, LR, LS, LT, LU, LV, LY, MA, MC, MD, ME, MF, MG, MH, MK, ML, MM, MN, MO, MP, MQ, MR, MS, MT, MU, MV, MW, MX, MY, MZ, NA, NC, NE, NF, NG, NI, NL, NO, NP, NR, NU, NZ, OM, PA, PE, PF, PG, PH, PK, PL, PM, PN, PR, PS, PT, PW, PY, QA, RE, RO, RS, RU, RW, SA, SB, SC, SD, SE, SG, SH, SI, SJ, SK, SL, SM, SN, SO, SR, SS, ST, SV, SX, SY, SZ, TC, TD, TF, TG, TH, TJ, TK, TL, TM, TN, TO, TR, TT, TV, TW, TZ, UA, UG, UM, US, UY, UZ, VA, VC, VE, VG, VI, VN, VU, WF, WS, XK, YE, YT, ZA, ZM, ZW Main contact email address
Telephone
URL
Label
External services which are linked to this customer
Amazon_Redshift, Google_BigQuery, Google_Sheets, HubSpot, NetSuite, QuickBooks_Online, Salesforce, Slack, Snowflake, Stripe, Xero Date and time the Customer was archived
Billing email addresses
Tax status applicable to customer. Can be one of TAXED, EXEMPT or REVERSE_CHARGED. The default is TAXED.
TAXED, TAX_EXEMPT, REVERSE_CHARGED Results pagination
Cursor for the page after this (if it exists)
Cursor for the page before this (if it exists)
Total number of entries across all pages
curl --request GET \
--url https://eu.sequencehq.com/api/customers \
--header 'Authorization: <authorization>'{
"items": [
{
"id": "e309e948-088e-4d77-b654-cd85498f1555",
"createdAt": "2022-06-28T16:47:00Z",
"legalName": "John Doe",
"contactName": "John Doe",
"address": {
"line1": "Flat 1",
"line2": "123 Fake Street",
"town": "New York",
"state": "NY",
"postcode": "AB1 2EF",
"country": "US"
},
"email": "john@example.com",
"telephone": "02010001000",
"url": "https://example.com/",
"label": "Example customer",
"integrationIds": [
{
"service": "Xero",
"id": "ID",
"lastSynced": "2022-06-28T16:47:00Z"
},
{
"service": "Stripe",
"id": "cus_OCtCxqQDgu1uX9",
"lastSynced": "2022-06-28T16:47:00Z"
}
],
"archivedAt": "2022-06-28T16:47:00Z",
"billingEmails": [
"exampleCorpInvoices@example.com"
],
"taxStatus": "TAXED"
}
],
"pagination": {
"after": "MDE4NDUyNjYtNmQ2NC03N2M4LTlhZGYtNDQ4N2Q5NGQxNDU3",
"before": "MDE4NDQyMWUtYTljYy03MTFiLWFmOTMtYmYwNTExZDRkODMz",
"totalResultSize": 10
}
}