Skip to main content
GET
Get list
SystemUser permission: EntityService:getEntitiesByTypeWithFilters, JobService:create

Authorizations

Authorization
string
header
required

JWT bearer token obtained from POST /auth/system-login using your client credentials.

Query Parameters

page
integer
default:1

Page number for pagination.

Required range: x >= 1
limit
integer
default:10

Number of entities per page.

Required range: 1 <= x <= 100
filters
string

Filters to apply. Pass as a URL-encoded JSON string.

Example usage in query string:

filters=%7B%22entityFor%22%3A%22customer%22%7D

Example usage in code:

attributes
string

List of attributes to return. Pass as a URL-encoded JSON array.

Example usage in query string:

attributes=%5B%22id%22%2C%22legalName%22%2C%22bankDetails%22%2C%22alias%22%2C%22Addresses.address1%22%2C%22Addresses.address2%22%2C%22Addresses.city%22%2C%22Addresses.zip%22%2C%22Addresses.State.name%22%2C%22Addresses.State.Country.name%22%2C%22email%22%2C%22phoneNumber%22%2C%22cc%22%2C%22bcc%22%2C%22Customer.name%22%2C%22entityForId%22%2C%22contractCount%22%5D

groupBy
string

Fields to group by. Pass as a URL-encoded JSON array.

Example usage in query string:

groupBy=%5B%22Entity.id%22%2C%22Addresses.id%22%5D

sortBy
string

Field to sort by.

Example:

"createdAt"

sortOrder
enum<string>

Sort order.

Available options:
asc,
desc
Example:

"desc"

Search/filter string

Response

Success. Returns a paginated list of customer entities.

status
string
message
string
data
object