Skip to main content
GET
/
external
/
customers
Get customers
curl --request GET \
  --url https://platform.runonatlas.com/external/customers \
  --header 'x-api-key: <api-key>'
{
  "results": [
    {
      "createdAt": "2021-01-01T00:00:00.000Z",
      "id": "atlas-internal-customer-id-123",
      "updatedAt": "2021-01-01T00:00:00.000Z",
      "merchantId": "atlas-internal-merchant-id-123",
      "billingAddress1": "123 Main St",
      "billingAddress2": "Apt 1",
      "billingCity": "Anytown",
      "billingCountry": "US",
      "billingState": "CA",
      "billingZipCode": "12345",
      "shippingAddress1": "123 Main St",
      "shippingAddress2": "Apt 1",
      "shippingCity": "Anytown",
      "shippingCountry": "US",
      "shippingState": "CA",
      "shippingZipCode": "12345",
      "email": "[email protected]",
      "externalId": "external-customer-id-123",
      "name": "John Doe",
      "quickBooksId": "quickbooks-customer-id-123",
      "stripeId": "stripe-customer-id-123"
    }
  ],
  "count": 100,
  "pages": 10,
  "currentPage": 1
}

Authorizations

​
x-api-key
string
header
required

You can obtain this key from the Atlas dashboard. It must be of type secret

Query Parameters

​
externalId
string

The external ID of the customer (e.g. the customer ID in your system)

Minimum string length: 1
Example:

"external-customer-id-123"

​
id
string

The Atlas customer ID

Minimum string length: 1
Example:

"atlas-internal-customer-id-123"

​
quickBooksId
string

The QuickBooks ID of the customer

Minimum string length: 1
Example:

"quickbooks-customer-id-123"

​
stripeId
string

The Stripe ID of the customer

Minimum string length: 1
Example:

"stripe-customer-id-123"

​
email
string<email>

The email of the customer

Minimum string length: 1
Example:

"[email protected]"

​
name
string

The name of the customer

Minimum string length: 1
Example:

"John Doe"

​
order
enum<string>
default:asc

The order of the results.

Available options:
asc,
desc
Example:

"asc"

​
page
integer
default:1

The page number of the results.

Required range: x >= 1
Example:

1

​
pageSize
integer
default:10

The number of results per page.

Required range: 1 <= x <= 100
Example:

10

​
orderBy
enum<string>
default:id

The fields that can be used to order the results by.

Available options:
createdAt,
email,
id,
name,
quickBooksId,
stripeId,
updatedAt
Example:

"id"

Response

The customers that have been retrieved.

​
results
object[]
required
​
count
number
required

The total number of results.

Example:

100

​
pages
number
required

The total number of pages.

Example:

10

​
currentPage
number
required

The current page number.

Example:

1