List 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"
    }
  ]
}

GET

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"
    }
  ]
}

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

string

required

ID of the Business the customer is associated with.

Query Parameters

boolean

Include archived customers in the response. Defaults to false.

string

The external ID of the customer to fetch.

string

A case-insensitive substring used to filter customers whose external ID contains the specified value.

string

The name of the customers to fetch.

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"
    }
  ]
}

Customer object Get a customer

⌘I

Businesses

Financial Activity

Accounting Reports

Platform Configuration

Activity Metrics

Quickbooks

List customers

Path Parameters

Query Parameters

Response

​Path Parameters

​Query Parameters

​Response

Path Parameters

Query Parameters

Response