GET
/
customers
curl --request GET \
  --url https://api.sulu.sh/v0/customers \
  --header 'Authorization: Bearer <token>'
{
  "object": "list",
  "data": [
    {
      "id": "<string>",
      "object": "customer",
      "consumerId": "<string>",
      "merchantId": "<string>",
      "paymentAuthorizationEnabled": true,
      "authorizationToken": "<string>",
      "authorizationExpiresAt": "2023-11-07T05:31:56Z",
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z",
      "organization": {
        "id": "<string>",
        "name": "<string>",
        "billingEmail": "jsmith@example.com",
        "phone": "<string>",
        "address": {
          "line1": "<string>",
          "line2": "<string>",
          "city": "<string>",
          "state": "<string>",
          "country": "<string>",
          "zipCode": "<string>"
        }
      }
    }
  ],
  "pagination": {
    "limit": 123,
    "offset": 123,
    "total": 123
  }
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

​
organizationId
string
required

ID of the merchant organization to filter customers by

​
limit
integer
default:10

Number of customers to return

Required range: 1 <= x <= 100
​
offset
integer
default:0

Number of customers to skip

Required range: x >= 0

Response

200
application/json
List of customers retrieved successfully
​
object
enum<string>
Available options:
list
​
data
object[]
​
pagination
object

Offset-based pagination response.