GEgetmaintainx
Customers

List customers

Changed on

Endpoint used to list customer resources

get/customers

Request

  • Base URL
    https://api.getmaintainx.com/v1
  • Auth
    HTTP bearer

Query parameters

cursorstring

Last pagination reference

limitinteger

Maximum number of Customers returned

expandstring[]

Headers

x-organization-idinteger

Required if using a multi organizations token

Response

Successfully fetched Customers list

nextCursorstring nullable required

The cursor to retrieve the next page of Customers.

nextPageUrlstring nullable required

Path with query parameters that can be used to retrieve the next page of Customers.

Example response

{
  "customers": [
    {
      "id": 123456,
      "name": "Acme Manufacturing",
      "description": "Primary service customer",
      "archivedAt": "2025-01-22T15:30:00.000Z",
      "createdAt": "2025-01-22T15:30:00.000Z",
      "updatedAt": "2025-01-22T15:30:00.000Z",
      "extraFields": {
        "external_id": "QBO-42"
      },
      "organizationId": 1
    }
  ]
}

Changes