Complyt Docs
  1. Customers
Complyt Docs
  • Getting Started
    • Introduction to Sales Tax Calculation
    • Step By Step - Creating your first transaction
    • Step By Step - Creating VAT / Global Tax Transaction
  • Endpoints
    • Authentication
      • Authentication - Getting Started
      • Create JWT
      • Create JWT - Partnerships
      • Get Partnerships
      • Upsert Client- Partnerships
      • Delete Client- Partnerships
    • Customers
      • Get to Know
      • Get Customer
        GET
      • Get All Customers
        GET
      • Upsert Customer
        PUT
      • Update Customer
        PATCH
    • Exemptions
      • Get to Know
      • Get All Exemptions
      • Post Exemption
      • Update Exemption
      • Patch Exemption
    • Transactions
      • Get to Know
      • The Importance of Shipping Address
      • How to Use Credit Memos
      • Get Transaction (thin)
      • Get Transaction
      • Upsert Transaction
      • Delete Transaction
      • Get All Transactions (thin)
      • Get All Transactions
      • Upsert VAT / GT Transactio
    • Files
      • Get All Files
      • Get One file - With signed link
      • Save file
      • Delete one file
    • Address Validation
      • Address Validation Intro
      • Validate Address
    • Sales Tax Rates
      • Get Sales Tax Rates
    • Vat Validation
      • Validate Vat
  • Special Features
    • Global Tax Rate
    • Partial Address
    • Discounts
    • Inclusive Tax
    • Vat Validation
    • Post exemptions from CSV
      POST
  • Applications
    • Xero - Integration & User Manual
  1. Customers

Get All Customers

GET
/v1/customers
Get all Customers
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET '/v1/customers'
Response Response Example
200 - Success
{
    "complytId": "9f8ee193-1a71-42b4-801d-ee1d8a161fbe",
    "externalId": "externalIdExample",
    "source": "sourceExample",
    "name": "Complyt",
    "address": {
        "city": "Sacramento",
        "country": "US",
        "county": null,
        "state": "CA",
        "street": "944 W. Wintergreen St.",
        "zip": "95823",
        "isPartial": false
    },
    "email": "example@some.mail.com",
    "customerType": "RETAIL",
    "internalTimestamps": {
        "createdDate": "2023-01-10T17:40:44.357",
        "updatedDate": "2023-01-11T17:10:21.275"
    },
    "externalTimestamps": {
        "createdDate": "2022-10-19T07:00:00",
        "updatedDate": "2022-10-19T09:07:54.585"
    },
    "comment": "this is a customer"
}

Request

Authorization
Provide your bearer token in the
Authorization
header when making requests to protected resources.
Example:
Authorization: Bearer ********************

Responses

🟢200Successful operation
application/json
Body

🟠400Something is wrong with your request
🟠401Unauthorized
🟠403Forbidden
🔴500Internal Error
Modified at 2025-01-01 15:21:30
Previous
Get Customer
Next
Upsert Customer
Built with