Customers
List all customers
This endpoint retrieves all existing customers.
GET
/
customers
Authorization
Query
LAGO_URL="https://api.getlago.com"
API_KEY="__YOUR_API_KEY__"
curl --location --request GET "$LAGO_URL/api/v1/customers?per_page=2&page=1" \
--header "Authorization: Bearer $API_KEY"
{
"customers": [
{
"address_line1": "5230 Penfield Ave",
"address_line2": "null",
"applicable_timezone": "America/Los_Angeles",
"billing_configuration": {},
"city": "Woodland Hills",
"country": "US",
"created_at": "2022-04-29T08:59:51Z",
"currency": "USD",
"email": "dinesh@piedpiper.test",
"external_id": "5eb02857-a71e-4ea2-bcf9-57d3a41bc6ba",
"lago_id": "1a901a90-1a90-1a90-1a90-1a901a901a90",
"legal_name": "Coleman-Blair",
"legal_number": "49-008-2965",
"logo_url": "http://hooli.com/logo.png",
"metadata": [],
"name": "Gavin Belson",
"net_payment_term": 30,
"phone": "1-171-883-3711 x245",
"sequential_id": 1,
"slug": "LAG-1234-001",
"state": "CA",
"tax_identification_number": "EU123456789",
"timezone": "America/Los_Angeles",
"updated_at": "2022-04-29T08:59:51Z",
"url": "http://hooli.com",
"zipcode": "91364",
"taxes": []
}
],
"meta": {
"current_page": 2,
"next_page": 3,
"prev_page": 1,
"total_count": 70,
"total_pages": 4
}
}
Authorizations
Authorization
string
headerrequiredBearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Query Parameters
page
integer
Page number.
per_page
integer
Number of records per page.
Response
200 - application/json
customers
object[]
requiredmeta
object
requiredWas this page helpful?
LAGO_URL="https://api.getlago.com"
API_KEY="__YOUR_API_KEY__"
curl --location --request GET "$LAGO_URL/api/v1/customers?per_page=2&page=1" \
--header "Authorization: Bearer $API_KEY"
{
"customers": [
{
"address_line1": "5230 Penfield Ave",
"address_line2": "null",
"applicable_timezone": "America/Los_Angeles",
"billing_configuration": {},
"city": "Woodland Hills",
"country": "US",
"created_at": "2022-04-29T08:59:51Z",
"currency": "USD",
"email": "dinesh@piedpiper.test",
"external_id": "5eb02857-a71e-4ea2-bcf9-57d3a41bc6ba",
"lago_id": "1a901a90-1a90-1a90-1a90-1a901a901a90",
"legal_name": "Coleman-Blair",
"legal_number": "49-008-2965",
"logo_url": "http://hooli.com/logo.png",
"metadata": [],
"name": "Gavin Belson",
"net_payment_term": 30,
"phone": "1-171-883-3711 x245",
"sequential_id": 1,
"slug": "LAG-1234-001",
"state": "CA",
"tax_identification_number": "EU123456789",
"timezone": "America/Los_Angeles",
"updated_at": "2022-04-29T08:59:51Z",
"url": "http://hooli.com",
"zipcode": "91364",
"taxes": []
}
],
"meta": {
"current_page": 2,
"next_page": 3,
"prev_page": 1,
"total_count": 70,
"total_pages": 4
}
}