List All Customers

get

https://embarc-api-qa.lendapi.com/embarc-core/api/v1/clients

This endpoint retrieves a list of clients with support for field selection, pagination, and sorting.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

officeId

integer

Defaults to 1

The unique identifier of an office.

Regex: ^\d+$

Example: 1

externalId

string

Defaults to exabse1232-wk

The external id of a customer that can be link from out side process.

Search by: Case Sensitive, Partial

Example: exabse1232-wk

lastName

string

Defaults to Yton

The lastName of a customer.

Search by: Case Sensitive, Partial

Example: Yton

offset

string

Defaults to 0

The first position of the pagination list start from 0.

Regex: ^\d+$

Example: 0

limit

string

Defaults to 20

The number of items in the pagination list that being queried.

Regex: ^\d+$

Example: 20

orderBy

string

Defaults to displayName

order by any available searching query parameters.

Example: displayName

sortOrder

string

Defaults to DESC

sort by ascending or descending.

ASC - ASCENDING, DESC - DESCENDING

Example: DESC

legalForm

string

Defaults to 1

The unique identifier of legal form.

Regex: ^\d+$

Example: 1

displayName

string

Defaults to Petra

The displayName of a customer.

Search by: Case Sensitive, Partial

Example: Petra

status

string

Defaults to ACTIVE

The status of a customer.

INVALID - in invalid status
PENDING - in pending status
ACTIVE - in active status
CLOSED - in closed status
REJECTED - in rejected status
WITHDRAWN - in withdrawn status

Example: ACTIVE

Headers

x-embarc-tenant-id

string

required

Defaults to default

Responses

Language

Credentials

Bearer

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200

400Bad Request