List notifications by org

GET

/Query/notifications/org/:orgId

GET

/api/Query/notifications/org/:orgId

$ curl -G https://api-sandbox.payabli.com/api/Query/notifications/org/123 \
>      -d fromRecord=251 \
>      -d limitRecord=0 \
>      -d sortBy=desc(field_name)

1 {
2   "Records": [
3     {
4       "content": {
5         "eventType": "ReceivedChargeBack",
6         "timeZone": 0
7       },
8       "createdAt": "2022-06-07T05:00:00Z",
9       "frequency": "untilcancelled",
10       "lastUpdated": "2022-06-07T05:00:00Z",
11       "method": "email",
12       "notificationId": 88976,
13       "ownerId": 123,
14       "ownerName": "Pilgrim Planner",
15       "ownerType": 2,
16       "source": "api",
17       "status": 1,
18       "target": "example@example.com"
19     },
20     {
21       "content": {
22         "eventType": "ReceivedAchReturn",
23         "timeZone": 0
24       },
25       "createdAt": "2022-06-07T05:00:00Z",
26       "frequency": "untilcancelled",
27       "lastUpdated": "2022-06-07T05:00:00Z",
28       "method": "email",
29       "notificationId": 88975,
30       "ownerId": 123,
31       "ownerName": "Pilgrim Planner",
32       "ownerType": 2,
33       "source": "api",
34       "status": 1,
35       "target": "example@example.com"
36     }
37   ],
38   "Summary": {
39     "pageSize": 20,
40     "totalAmount": 0,
41     "totalNetAmount": 0,
42     "totalPages": 1,
43     "totalRecords": 2
44   }
45 }

Return a list of notifications for an organization. Use filters to limit results.

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.

List of field names accepted:

frequency (in, nin,ne, eq)
method (in, nin, eq, ne)
event (in, nin, eq, ne)
target (ct, nct, eq, ne)
status (eq, ne)

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
nin => not inside array

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: totalAmount(gt)=20 return all records with totalAmount greater than 20.00

Collection of field names, conditions, and values used to filter the query <Info> **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 </Info> See [Filters and Conditions Reference](/developers/developer-guides/pay-ops-reporting-engine-overview#filters-and-conditions-reference) for help. List of field names accepted: - `frequency` (in, nin,ne, eq) - `method` (in, nin, eq, ne) - `event` (in, nin, eq, ne) - `target` (ct, nct, eq, ne) - `status` (eq, ne) 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 - nin => not inside array 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: totalAmount(gt)=20 return all records with totalAmount greater than 20.00

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