GET
/
Query
/
users
/
org
/
{orgId}

You must remove parameters= from the request before you send it, otherwise Payabli will ignore the filters.

Because of a technical limitation, you can’t make a request that includes filters from the API console on this page. The response won’t be filtered. Instead, copy the request, remove parameters= and run the request in a different client.

For example:

—url https://api-sandbox.payabli.com/api/Query/transactions/org/236?parameters=totalAmount(gt)=1000&limitRecord=20

should become:

—url https://api-sandbox.payabli.com/api/Query/transactions/org/236?totalAmount(gt)=1000&limitRecord=20

Authorizations

​
requestToken
string
header
required

Most endpoints require an organization token. Some endpoints require an application token, and those endpoints are noted.

Path Parameters

​
orgId
integer
required

The numeric identifier for organization, assigned by Payabli.

Query Parameters

​
parameters
object

Collection of field names, conditions, and values used to filter the query.

See Filters and Conditions Reference for help.

List of field names accepted:

  • createdDate (gt, ge, lt, le, eq, ne)
  • name (ne, eq, ct, nct)
  • email (ne, eq, ct, nct)
  • status (in, nin, eq, ne)
  • role.xxx (ne, eq, ct, nct) where xxx is the role field: roleLabel or roleValue

List of comparison accepted - enclosed between parentheses:

  • eq or empty => equal
  • gt => greater than
  • ge => greater or equal
  • lt => less than
  • le => less or equal
  • ne => not equal
  • ct => contains
  • nct => not contains
  • in => inside array separated by "|"
  • nin => not inside array separated by "|"

List of parameters accepted:

  • limitRecord: max number of records for query (default="20", "0" or negative value for all)
  • fromRecord: initial record in query

Example: name(ct)=john return all records with name containing 'john'.

​
limitRecord
integer
default:
20

Max number of records to return for the query. Use 0 or negative value to return all records.

​
fromRecord
integer

The number of records to skip before starting to collect the result set.

​
sortBy
string

The field name to use for sorting results. Use desc(field_name) to sort descending by field_name, and use asc(field_name) to sort ascending by field_name.

Response

200 - application/json
​
Records
object[]
​
Summary
object

Was this page helpful?

List Users for PaypointList Suborganizations