Skip to main content
GET
/
v1
/
businesses
/
{business_id}
/
customers
curl -X GET https://sandbox.layerfi.com/v1/businesses/${business_id}/customers/ \
  -H "Authorization: Bearer <access_token>" \

{
  "data": [
    {
      "external_id": "customer-1",
      "individual_name": "John Doe",
      "company_name": "Acme, Inc.",
      "email": "john@hotmail.com",
      "mobile_phone": "555-555-5555",
      "office_phone": "555-555-5555",
      "address_string": "123 Main St, Phoenix, AZ 85001",
      "notes": "This is a note"
    },
    {
      "external_id": "customer-2",
      "individual_name": "Jane Doe",
      "company_name": "MegaCorp",
      "email": "jane@hotmail.com"
    }
  ]
}

Documentation Index

Fetch the complete documentation index at: https://docs-beta.layerfi.com/llms.txt

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

The GET endpoint lists all created customers within Layer. Only active customers are returned by default, but archived customers can be included via the include_archived flag.

ā€‹
Path Parameters

ā€‹
business_id
string
required
ID of the Business the customer is associated with.

ā€‹
Query Parameters

ā€‹
include_archived
boolean
Include archived customers in the response. Defaults to false.
ā€‹
external_id
string
The external ID of the customer to fetch.
ā€‹
external_id_contains
string
A case-insensitive substring used to filter customers whose external ID contains the specified value.
ā€‹
name
string
The name of the customers to fetch.
ā€‹
name_contains
string
A case-insensitive substring used to filter customers whose name contains the specified value.

ā€‹
Response

Returns a list of Customer objects 
curl -X GET https://sandbox.layerfi.com/v1/businesses/${business_id}/customers/ \
  -H "Authorization: Bearer <access_token>" \

{
  "data": [
    {
      "external_id": "customer-1",
      "individual_name": "John Doe",
      "company_name": "Acme, Inc.",
      "email": "john@hotmail.com",
      "mobile_phone": "555-555-5555",
      "office_phone": "555-555-5555",
      "address_string": "123 Main St, Phoenix, AZ 85001",
      "notes": "This is a note"
    },
    {
      "external_id": "customer-2",
      "individual_name": "Jane Doe",
      "company_name": "MegaCorp",
      "email": "jane@hotmail.com"
    }
  ]
}