Skip to main content
GET
/
customers
List Customers
curl --request GET \
  --url https://api.atlas.co/functions/v1/customers \
  --header 'Authorization: Bearer <token>'
{
  "object": "list",
  "data": [
    {
      "id": "<string>",
      "object": "customer",
      "email": "<string>",
      "name": "<string>",
      "phone": "<string>",
      "description": "<string>",
      "billing_address": {
        "line1": "<string>",
        "line2": "<string>",
        "city": "<string>",
        "state": "<string>",
        "postal_code": "<string>",
        "country": "<string>"
      },
      "shipping_address": {
        "line1": "<string>",
        "line2": "<string>",
        "city": "<string>",
        "state": "<string>",
        "postal_code": "<string>",
        "country": "<string>"
      },
      "default_payment_method": "<string>",
      "tax_exempt": true,
      "tax_ids": [
        {
          "type": "<string>",
          "value": "<string>"
        }
      ],
      "metadata": {},
      "created": 123
    }
  ],
  "has_more": true,
  "total_count": 123
}

Authorizations

Authorization
string
header
required

API key (sk_test_* or sk_live_*)

Query Parameters

limit
integer
default:10
Required range: x <= 100
offset
integer
default:0
email
string

Response

200 - application/json

Customer list

object
enum<string>
Available options:
list
data
object[]
has_more
boolean
total_count
integer