List Customers

Returns a paginated list of Customers where the default limit is 150.

Loading API schema for Customer…

GET/api/v1/customers

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

{
  "requestId": "<string>",
  "success": "<boolean>",
  "data": [
    {
      "id": "<string>",
      "objectType": "<string>",
      "name": "<string>",
      "createdAt": "<date-time>",
      "updatedAt": "<date-time>",
      "revisionNumber": "<string>",
      "fullname": "<string>",
      "sublevel": "<integer>",
      "companyName": "<string>",
      "salutation": "<string>",
      "firstName": "<string>",
      "middleName": "<string>",
      "lastName": "<string>",
      "jobTitle": "<string>",
      "billingAddress": {
        "line1": "<string>",
        "line2": "<string>",
        "line3": "<string>",
        "line4": "<string>",
        "line5": "<string>",
        "city": "<string>",
        "state": "<string>",
        "postalCode": "<string>",
        "country": "<string>",
        "note": "<string>"
      },
      "shippingAddress": {
        "line1": "<string>",
        "line2": "<string>",
        "line3": "<string>",
        "line4": "<string>",
        "line5": "<string>",
        "city": "<string>",
        "state": "<string>",
        "postalCode": "<string>",
        "country": "<string>",
        "note": "<string>"
      },
      "alternateShippingAddresses": [
        {
          "line1": null,
          "line2": null,
          "line3": null,
          "line4": null,
          "line5": null,
          "city": null,
          "state": null,
          "postalCode": null,
          "country": null,
          "note": null,
          "name": null,
          "isDefaultShippingAddress": null
        }
      ],
      "phone": "<string>",
      "alternatePhone": "<string>",
      "fax": "<string>",
      "email": "<string>",
      "ccEmail": "<string>",
      "contact": "<string>",
      "alternateContact": "<string>",
      "customContactFields": [
        {
          "name": null,
          "value": null
        }
      ],
      "additionalContacts": [
        {
          "id": null,
          "objectType": null,
          "name": null,
          "createdAt": null,
          "updatedAt": null,
          "revisionNumber": null,
          "contactName": null,
          "salutation": null,
          "firstName": null,
          "middleName": null,
          "lastName": null,
          "jobTitle": null,
          "customContactFields": null,
          "isActive": null,
          "customFields": null
        }
      ],
      "class": {
        "id": "<string>",
        "fullname": "<string>"
      },
      "parent": {
        "id": "<string>",
        "fullname": "<string>"
      },
      "customerType": {
        "id": "<string>",
        "fullname": "<string>"
      },
      "terms": {
        "id": "<string>",
        "fullname": "<string>"
      },
      "salesRep": {
        "id": "<string>",
        "fullname": "<string>"
      },
      "salesTaxCode": {
        "id": "<string>",
        "fullname": "<string>"
      },
      "itemSalesTax": {
        "id": "<string>",
        "fullname": "<string>"
      },
      "preferredPaymentMethod": {
        "id": "<string>",
        "fullname": "<string>"
      },
      "jobType": {
        "id": "<string>",
        "fullname": "<string>"
      },
      "priceLevel": {
        "id": "<string>",
        "fullname": "<string>"
      },
      "currency": {
        "id": "<string>",
        "fullname": "<string>"
      },
      "balance": "<number>",
      "totalBalance": "<number>",
      "salesTaxCountry": "<string>",
      "resaleNumber": "<string>",
      "accountNumber": "<string>",
      "creditLimit": "<number>",
      "creditCard": {
        "objectType": "<string>",
        "creditCardNumber": "<string>",
        "expirationMonth": "<integer>",
        "expirationYear": "<integer>",
        "nameOnCard": "<string>",
        "creditCardAddress": "<string>",
        "creditCardPostalCode": "<string>"
      },
      "jobStatus": "<string>",
      "jobStartDate": "<date>",
      "jobProjectedEndDate": "<date>",
      "jobEndDate": "<date>",
      "jobDescription": "<string>",
      "notes": "<string>",
      "additionalNotes": [
        {
          "noteId": null,
          "date": null,
          "note": null
        }
      ],
      "preferredDeliveryMethod": "<string>",
      "taxRegistrationNumber": "<string>",
      "externalId": "<uuid>",
      "isActive": "<boolean>",
      "customFields": [
        {
          "ownerId": "<string>",
          "name": "<string>",
          "type": "<string>",
          "value": "<string>"
        }
      ]
    }
  ],
  "nextCursor": "<string>",
  "page": "<integer>",
  "count": "<integer>",
  "limit": "<integer>",
  "totalCount": "<integer>",
  "pageCount": "<integer>",
  "hasMore": "<boolean>",
  "timestamp": "<date-time>",
  "remainingCount": "<integer>"
}