Customers

List customers

Returns a paginated list of customers for the authenticated company.

GET

/customers

List customers

curl --request GET \
  --url 'https://api.getrotor.com/open-api/customers?page=1&limit=50&status=active&archived=false&tags=residential%2Cvip&search=Doe' \
  --header 'x-api-key: <api-key>' \
  --header 'rotor-api-version: 1.1.0'

{
  "data": [
    {
      "address": {
        "city": "<string>",
        "country": "<string>",
        "state": "<string>",
        "street1": "<string>",
        "street2": "<string>",
        "zip": "<string>"
      },
      "company_name": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "email": "jsmith@example.com",
      "first_name": "<string>",
      "has_payment_method": true,
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "last_name": "<string>",
      "location": [
        123
      ],
      "notes": "<string>",
      "payment_methods": [
        {
          "date_added": "2023-11-07T05:31:56Z",
          "type": "card"
        }
      ],
      "phone": "<string>",
      "source": "<string>",
      "status": "active",
      "tags": [
        "<string>"
      ]
    }
  ],
  "pagination": {
    "has_more": true,
    "limit": 50,
    "page": 1,
    "total": 142
  },
  "status": "success"
}

Authorizations

x-api-keystringheaderrequired

Company API key in the format: rotor_{keyId}_{keySecret}

To obtain an API key:

Log into your Rotor dashboard
Go to Settings → Integrations → API Keys
Create a new key and select the scopes you need
Copy the key — it's only shown once!

Query Parameters

pageintegerquerydefault:1

Page number (1-based)

Required range: 1 <= x

Example: 1

limitintegerquerydefault:50

Number of results per page (max 1000)

Required range: 1 <= x <= 1000

Example: 50

statusenum<string>query

Filter by customer status

Available options: active, inactive

Example: active

archivedbooleanquery

Include archived customers (default false)

Example: false

tagsstringquery

Filter by tags (comma-separated)

Example: residential,vip

searchstringquery

Search by first name, last name, company name, email, or phone

Example: Doe

Headers

rotor-api-versionenum<string>headerdefault:1.1.0required

Required OpenAPI version header.

Available options: 1.1.0

Example: 1.1.0

Response

Customers listed successfully

dataobject[]

Show child attributes

paginationobject

Show child attributes

statusstring

Example: success

Still need help? Ask the team