Skip to content
/
Lists customers

Lists customers

Request

GET {{baseURL}}/pay-api/v1/customers

This endpoint lists the partner's customers.

The search can specify filters to better target intended customers.

Navigation: [ Headers ] [ Query ] [ Request body ] [ Response body ] [ Response codes ]

See Also:
To create a customer, see POST /pay-api/v1/customers.
To retrieve a customer by ID, see GET /pay-api/v1/customers/{customerId}.
To update a customer's information, see PUT /pay-api/v1/customers/{customerId}.
To delete a customer, see DELETE /pay-api/v1/customers/{customerId}.

Security
Bearer
Query
searchstring

Specifies the search string.

This performs a case insensitive, matching, or partially matching search.

Fields does not have to be specified. If the results are to be sorted, use the field orderby to specify the sort field.

firstName
lastName
companyName
email
mobilePhoneNumber
id
createdOn
lastTransactionDate
contactName

Example: Conners Electric

Example:search=Conners Electric
customerIdsstring, (uuid)

Specifies a single customer's identifier.

Example: c4b210e9-be39-4ebc-8195-0c422de87f90

Example:customerIds=c4b210e9-be39-4ebc-8195-0c422de87f90
orderBystring

Specifies the field the results get ordered by.

The sort order is specified by the asc value.

Example: contactName

ascboolean

Specifies the sort order.

The sort field is specified by the orderBy value.

If true, the sort order is ascending.
If false, the sort order is descending.

Example: false

Default:false
dateFromstring, (date-time)

Specifies a filter to return items at or after this date-time (in an ISO 8601 date-time format).).

If dateFrom only is specified, the search returns all available items from the dateFrom value to the present. The fields dateFrom and dateTo may be used together to create an inclusive range. We recommend creating an inclusive range to avoid a potentially excessive number of returns.

Example: 2025-01-27T12:05:54.322587Z

Example:dateFrom=2025-01-27T12:05:54.322587Z
dateTostring, (date-time)

Specifies returning items at or before this date-time (in an ISO 8601 date-time format).

If dateTo only is specified, the search returns all available items up to the dateTo value. The fields dateFrom and dateTo may be used together to create an inclusive range. We recommend creating an inclusive range to avoid a potentially excessive number of returns.

Example: 2026-01-27T12:05:54.322587Z

Example:dateTo=2026-01-27T12:05:54.322587Z
pageinteger, (int32)

Specifies the page number of the returned search results.

A page is considered each set of the pageSize value.

The maximum page value is the pageSize divided by the total count rounded up. The count is zero-based. For example, if pageSize is 50 and the total is 130, there are three pages. The maximum page value is 2.

Values above the maximum page value will complete successfully but not return any items.

Example: 0

Default:0
pageSizeinteger, (int32)

Specifies the number of items for each page of the returned search results.

A page is considered each set of the pageSize value.

The maximum page value is the pageSize divided by the total count rounded up. The count is zero-based. For example, if pageSize is 50 and the total is 130, there are three pages. The maximum page value is 2.

Example: 50

Default:15
curl -i -X GET \
  'https://developer.flute.com/_mock/api-reference/pay-api/v1/customers?search=Conners%20Electric&customerIds=c4b210e9-be39-4ebc-8195-0c422de87f90&orderBy=string&asc=false&dateFrom=2025-01-27T12%3A05%3A54.322587Z&dateTo=2026-01-27T12%3A05%3A54.322587Z&page=0&pageSize=15' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

OK

Bodyapplication/json
itemsArray of objects or null

Customers for the current page.

totalinteger, (int32)

Indicates the total number of customers found.

Example: 5

Example:5
Response
{
  "items": [
    {
      "id": "019bf058-960f-72a0-8194-6d554c7d6004",
      "createdOn": "2025-01-27T12:05:54.322587Z",
      "modifiedOn": "2025-01-27T12:05:54.322587Z",
      "lastTransactionDate": "2025-01-27T12:05:54.322587Z",
      "lastTransactionAmount": 0.1,
      "activeSubscriptionsAmount": 0.1,
      "contactName": "Alexandro Peppared",
      "firstName": "Alexandro",
      "lastName": "Peppared",
      "companyName": "Peppared Street Cafe",
      "email": "peppared@example.com",
      "mobilePhoneNumber": "+14155552309",
      "isMobileNumberSmsNotificationsEnabled": true,
      "billingAddress": {
        "addressLine1": "21 E. Main Street",
        "addressLine2": "Office 3",
        "city": "Chicago",
        "zip": "60612",
        "stateName": "Illinois",
        "state": {
          "id": 0,
          "code": "IL",
          "name": "Illinois"
        },
        "country": {
          "id": 1,
          "isoCode": "US",
          "name": "United States"
        }
      },
      "paymentMethodsCount": 0
    }
  ],
  "total": 5
}