API Reference

List customers (company and individual)

get
https://app.pennylane.com/api/external/v2/customers

This endpoint returns a list of both company and individual customers

This endpoint requires one of the following scopes: customers:all, customers:readonly

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
string

Cursor for pagination. Use this to fetch the next set of results. The cursor is an opaque string returned in the previous response's metadata. Leave empty for the first request.

integer
1 to 100

Number of items to return per request. Defaults to 20 if not specified. Must be between 1 and 100.

string

You can choose to filter items on specific fields. Available fields and values:

  • id: lt, lteq, gt, gteq, eq, not_eq, in, not_in
  • customer_type: eq, not_eq
  • ledger_account_id: eq, not_eq
  • name: start_with, eq
  • external_reference: start_with, eq, not_eq, in, not_in
  • reg_no: eq, not_eq, in, not_in
  • emails: in
string
Defaults to -id

You can choose to sort items on specific attributes Sort field may be prefixed with - for descending order. Example : id will sort by ascending order, -id will sort by descending order. Available fields : id

Responses

Updated 9 days ago

Language
Credentials
OAuth2
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 9 days ago