List users by org

GET

/Query/users/org/:orgId

GET

/api/Query/users/org/:orgId

curl -G https://api-sandbox.payabli.com/api/Query/users/org/123 \
     -H "Authorization: Bearer <token>" \
     -d fromRecord=251 \
     -d limitRecord=0 \
     -d sortBy=desc(field_name)

{
  "Records": [
    {
      "Access": [
        {
          "roleValue": true
        }
      ],
      "AdditionalData": {
        "key1": "value1",
        "key2": "value2"
      },
      "createdAt": "2022-07-01T15:00:01Z",
      "Email": "example@email.com",
      "language": "en",
      "lastAccess": "2022-07-01T15:00:01Z",
      "Name": "Sean Smith",
      "Phone": "5555555555",
      "Scope": [
        {
          "orgType": 0
        }
      ],
      "snData": "snData",
      "snIdentifier": "snIdentifier",
      "snProvider": "google",
      "timeZone": -5,
      "userId": 1000000,
      "UsrMFA": false,
      "UsrMFAMode": 0,
      "UsrStatus": 1
    }
  ],
  "Summary": {
    "pageidentifier": "null",
    "pageSize": 20,
    "totalAmount": 77.22,
    "totalNetAmount": 77.22,
    "totalPages": 2,
    "totalRecords": 2
  }
}

Get list of users for an org. Use filters to limit results.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

requestTokenstring

Long-lived API token sent in the requestToken header. See API token authentication.

Path parameters

orgIdintegerRequired

The numeric identifier for organization, assigned by Payabli.

Query parameters

fromRecordintegerOptionalDefaults to 0

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

limitRecordintegerOptionalDefaults to 20

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

parametersmap from strings to nullable stringsOptional

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

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

See Filters and Conditions Reference for help.

Accepted field names:

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

Accepted comparison operators - 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 "|"

Accepted parameters:

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'.

sortBystringOptional

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

Success

Recordslist of objectsOptional

SummaryobjectOptional

Errors

400

Bad Request Error

401

Unauthorized Error

500

Internal Server Error

503

Service Unavailable Error