List Customers

Returns a paginated list of Customers where the default and maximum limits are both 150.

Loading API schema for Customer…

GET/api/v1/customers

bash

curl -X GET "https://api.nx-us.net/api/v1/customers" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "X-Connection-Id: YOUR_CONNECTION_ID" \
  -H "Accept: application/json"

Response200

json

{
  "requestId": "<string>",
  "success": "<boolean>",
  "data": [
    {
      "id": "<string>",
      "objectType": "<string>",
      "name": "Acme Corporation",
      "createdAt": "<date-time>",
      "updatedAt": "<date-time>",
      "revisionNumber": "<string>",
      "fullname": "ABC Corporation:Website Redesign Project",
      "sublevel": "1",
      "companyName": "Acme Corporation",
      "salutation": "Dr.",
      "firstName": "John",
      "middleName": "A.",
      "lastName": "Doe",
      "jobTitle": "Purchasing Manager",
      "billingAddress": {},
      "shippingAddress": {},
      "alternateShippingAddresses": [],
      "phone": "+1-555-123-4567",
      "alternatePhone": "+1-555-987-6543",
      "fax": "+1-555-555-1212",
      "email": "customer@example.com",
      "ccEmail": "manager@example.com",
      "contact": "Jane Smith",
      "alternateContact": "Bob Johnson",
      "customContactFields": [],
      "additionalContacts": [],
      "class": {},
      "parent": {},
      "customerType": {},
      "terms": {},
      "salesRep": {},
      "salesTaxCode": {},
      "itemSalesTax": {},
      "preferredPaymentMethod": {},
      "jobType": {},
      "priceLevel": {},
      "currency": {},
      "balance": "1000.00",
      "totalBalance": "5000.00",
      "salesTaxCountry": "us",
      "resaleNumber": "123456789",
      "accountNumber": "1010",
      "creditLimit": "5000.00",
      "creditCard": {},
      "jobStatus": "InProgress",
      "jobStartDate": "2024-01-15",
      "jobProjectedEndDate": "2024-12-31",
      "jobEndDate": "2024-11-30",
      "jobDescription": "Kitchen renovation project for residential client.",
      "notes": "Our favorite customer.",
      "additionalNotes": [],
      "preferredDeliveryMethod": "Email",
      "taxRegistrationNumber": "GB123456789",
      "externalId": "12345678-abcd-1234-abcd-1234567890ab",
      "isActive": "<boolean>",
      "customFields": [
        {
          "ownerId": null,
          "name": null,
          "type": null,
          "value": null
        }
      ]
    }
  ],
  "count": "<integer>",
  "limit": "<integer>",
  "totalCount": "<integer>",
  "timestamp": "<date-time>",
  "nextCursor": "<string>",
  "hasMore": "<boolean>",
  "remainingCount": "<integer>"
}