Skip to main content
GET
/
customers
List Customers
curl --request GET \
  --url https://api.loopreturns.com/api/v1/customers \
  --header 'X-Authorization: <api-key>'
{
  "customers": [
    {
      "id": 123,
      "external_id": "<string>",
      "channel": "<string>",
      "first_name": "<string>",
      "last_name": "<string>",
      "email": "jsmith@example.com",
      "phone": "<string>",
      "tags": [
        "<string>"
      ]
    }
  ],
  "next_page_url": "<string>",
  "previous_page_url": "<string>"
}

Documentation Index

Fetch the complete documentation index at: https://docs.loopreturns.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
X-Authorization
string
header
required

API Scope: "Customers (read)"

Query Parameters

​
external_id
string

An external_id used to filter the customers.

Example:

"28hs67udfh-213csss-12d31ja"

​
limit
integer
default:50

The maximum number of customers returned.

Required range: 1 <= x <= 250
Example:

20

​
sort_order
enum<string>
default:asc

The sort order for the results.

Available options:
asc,
desc
Example:

"asc"

​
cursor
string

The cursor to return the next page of results.

Response

Success

​
customers
object[]
​
next_page_url
string
​
previous_page_url
string