GET
/
Query
/
customers
/
org
/
{orgId}
curl --request GET \
  --url https://api-sandbox.payabli.com/api/Query/customers/org/{orgId} \
  --header 'requestToken: <api-key>'
{
  "Summary": {
    "totalRecords": 510,
    "totalAmount": 0,
    "totalNetAmount": 0,
    "totalPages": 26,
    "pageSize": 20,
    "pageIdentifier": "XXXXXXXXXXXXXX"
  },
  "Records": [
    {
      "customerId": 2876,
      "customerNumber": "425436530000",
      "customerUsername": null,
      "customerStatus": 0,
      "Company": "Boudreaux's Shop",
      "Firstname": "Thibodeaux",
      "Lastname": "Hebert",
      "Phone": "(504) 823-4566",
      "Email": "thibodeaux.hebert@bayoumail.com",
      "Address": "1234 Bayou Road",
      "Address1": "Suite 2",
      "City": "Lafayette",
      "State": "LA",
      "Zip": "70501",
      "Country": "US",
      "ShippingAddress": "1234 Bayou Road",
      "ShippingAddress1": "Suite 2",
      "ShippingCity": "Lafayette",
      "ShippingState": "LA",
      "ShippingZip": "70501",
      "ShippingCountry": "US",
      "Balance": 0,
      "TimeZone": 0,
      "MFA": false,
      "MFAMode": 0,
      "snProvider": null,
      "snIdentifier": null,
      "snData": null,
      "LastUpdated": "2023-12-20T13:07:48.63",
      "Created": "2023-12-20T13:07:48.63",
      "AdditionalFields": {},
      "IdentifierFields": [
        "email"
      ],
      "Subscriptions": null,
      "StoredMethods": null,
      "customerSummary": {
        "numberofTransactions": 30,
        "totalAmountTransactions": 1500,
        "totalNetAmountTransactions": 1500
      },
      "PaypointLegalname": "Global Factory LLC",
      "PaypointDbaname": "Global Factory LLC",
      "ParentOrgName": "SupplyPro",
      "PaypointEntryname": "4872acb376a",
      "pageidentifier": null,
      "externalPaypointID": "pay-10"
    }
  ]
}

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.

Example:

123

Query Parameters

​
parameters
object

Collection of field names, conditions, and values used to filter the query. See Filters and Conditions Reference for more details.

List of Accepted Field Names:

  • createdDate (gt, ge, lt, le, eq, ne)
  • customernumber (ne, eq, ct, nct)
  • firstname (ne, eq, ct, nct)
  • lastname (ne, eq, ct, nct)
  • name (ct, nct)
  • address (ne, eq, ct, nct)
  • city (ne, eq, ct, nct)
  • country (ne, eq, ct, nct)
  • zip (ne, eq, ct, nct)
  • state (ne, eq, ct, nct)
  • shippingaddress (ne, eq, ct, nct)
  • shippingcity (ne, eq, ct, nct)
  • shippingcountry (ne, eq, ct, nct)
  • shippingzip (ne, eq, ct, nct)
  • shippingstate (ne, eq, ct, nct)
  • phone (ne, eq, ct, nct)
  • email (ne, eq, ct, nct)
  • company (ne, eq, ct, nct)
  • username (ne, eq, ct, nct)
  • balance (gt, ge, lt, le, eq, ne)
  • status (in, nin, eq, ne)
  • additional-xxx (ne, eq, ct, nct) where xxx is the additional field name
  • orgId (eq) mandatory when entry=org
  • paypointId (ne, eq)
  • paypointLegal (ne, eq, ct, nct)
  • paypointDba (ne, eq, ct, nct)
  • orgName (ne, eq, ct, nct)

List of Accepted Comparisons:

  • 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 Usage: balance(gt)=20 will return all records with a balance greater than 20.00.

​
limitRecord
integer
default:20

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

Example:

0

​
fromRecord
integer
default:0

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

Example:

251

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

Example:

"desc(field_name)"

Response

200
application/json

Success

The response is of type object.