Skip to main content
GET
/
customers
List customers
curl --request GET \
  --url https://api.nomos.energy/customers \
  --header 'Authorization: Bearer <token>'
{
  "items": [
    {
      "id": "cus_xjyx97wqh1r1hscr2ti1xvoq",
      "first_name": "John",
      "last_name": "Doe",
      "email": "john.doe@example.com",
      "created_at": "2024-03-14T12:00:00Z",
      "type": "person"
    }
  ],
  "next_page": "<string>",
  "has_more": false
}

Documentation Index

Fetch the complete documentation index at: https://docs.nomos.energy/llms.txt

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

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

​
cursor
string | null
​
limit
number
default:10
Required range: 1 <= x <= 100
​
filter[field][operator]
any | null

Filterable fields:

  • email (string)
  • type (string)
  • created_at (date)

See Filtering Documentation for supported operators and syntax.

Example:

"value"

Response

Retrieve all customers with cursor pagination

​
object
enum<string>
required
Available options:
list
​
items
object[]
required
​
next_page
string | null
​
has_more
boolean
default:false