# List notifications by paypoint

GET https://api-sandbox.payabli.com/api/Query/notifications/{entry}

Returns a list of notifications for an entrypoint. Use filters to limit results.

Reference: https://docs.payabli.com/developers/api-reference/notification/get-list-of-notifications-for-an-entrypoint

## OpenAPI Specification

```yaml
openapi: 3.1.1
info:
  title: Get list of notifications for an entrypoint
  version: endpoint_query.ListNotifications
paths:
  /Query/notifications/{entry}:
    get:
      operationId: list-notifications
      summary: Get list of notifications for an entrypoint
      description: >-
        Returns a list of notifications for an entrypoint. Use filters to limit
        results.
      tags:
        - - subpackage_query
      parameters:
        - name: entry
          in: path
          required: true
          schema:
            $ref: '#/components/schemas/type_:Entry'
        - name: fromRecord
          in: query
          description: >-
            The number of records to skip before starting to collect the result
            set.
          required: false
          schema:
            type: integer
            default: 0
        - name: limitRecord
          in: query
          description: >-
            Max number of records to return for the query. Use `0` or negative
            value to return all records.
          required: false
          schema:
            type: integer
            default: 20
        - name: parameters
          in: query
          description: >-
            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
          required: false
          schema:
            type: object
            additionalProperties:
              type: string
        - name: sortBy
          in: query
          description: >-
            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`.
          required: false
          schema:
            type: string
        - name: requestToken
          in: header
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_:QueryResponseNotifications'
        '400':
          description: Bad request/ invalid data
          content: {}
        '401':
          description: Unauthorized request.
          content: {}
        '500':
          description: Internal API Error
          content: {}
        '503':
          description: Database connection error
          content: {}
components:
  schemas:
    type_:Entry:
      type: string
    type_:NotificationContentEventType:
      type: string
      enum:
        - value: ApprovedPayment
        - value: AuthorizedPayment
        - value: DeclinedPayment
        - value: OriginatedPayment
        - value: SettledPayment
        - value: SubscriptionCreated
        - value: SubscriptionUpdated
        - value: SubscriptionCanceled
        - value: SubscriptionCompleted
        - value: FundedPayment
        - value: VoidedPayment
        - value: RefundedPayment
        - value: HoldTransaction
        - value: ReleasedTransaction
        - value: HoldBatch
        - value: ReleasedBatch
        - value: TransferDisabledCreditFund
        - value: TransferDisabledDebitFund
        - value: TransferNotAvailableBalance
        - value: TransferReturn
        - value: TransferSuccess
        - value: TransferSuspended
        - value: TransferError
        - value: SendReceipt
        - value: RecoveredTransaction
        - value: CreatedApplication
        - value: ApprovedApplication
        - value: FailedBoardingApplication
        - value: SubmittedApplication
        - value: UnderWritingApplication
        - value: ActivatedMerchant
        - value: ReceivedChargeBack
        - value: ChargebackUpdated
        - value: ReceivedRetrieval
        - value: RetrievalUpdated
        - value: ReceivedAchReturn
        - value: HoldingApplication
        - value: DeclinedApplication
        - value: BoardingApplication
        - value: FraudAlert
        - value: InvoiceSent
        - value: InvoicePaid
        - value: InvoiceCreated
        - value: BillPaid
        - value: BillApproved
        - value: BillDisApproved
        - value: BillCanceled
        - value: BillProcessing
        - value: CardCreated
        - value: CardActivated
        - value: CardDeactivated
        - value: CardExpired
        - value: CardExpiring
        - value: CardLimitUpdated
        - value: BatchClosed
        - value: BatchNotClosed
        - value: PayOutFunded
        - value: PayOutProcessed
        - value: PayOutCanceled
        - value: PayOutPaid
        - value: PayOutReturned
        - value: PayoutSubscriptionCreated
        - value: PayoutSubscriptionUpdated
        - value: PayoutSubscriptionCanceled
        - value: PayoutSubscriptionCompleted
        - value: PayoutSubscriptionReminder
        - value: importFileReceived
        - value: importFileProcessed
        - value: importFileError
        - value: exportFileSent
        - value: exportFileError
        - value: FailedEmailNotification
        - value: FailedWebNotification
        - value: FailedSMSNotification
        - value: UserPasswordExpiring
        - value: UserPasswordExpired
        - value: TransactionNotFound
        - value: SystemAlert
        - value: Report
    type_:NotificationContentFileFormat:
      type: string
      enum:
        - value: json
        - value: csv
        - value: xlsx
    type_:KeyValueDuo:
      type: object
      properties:
        key:
          type: string
          description: Key name.
        value:
          type: string
          description: Key value.
    type_:NotificationContentReportName:
      type: string
      enum:
        - value: Transaction
        - value: Settlement
        - value: Boarding
        - value: Returned
    type_:Timezone:
      type: integer
    type_:NotificationContent:
      type: object
      properties:
        eventType:
          $ref: '#/components/schemas/type_:NotificationContentEventType'
          description: The notification's event name.
        fileFormat:
          $ref: '#/components/schemas/type_:NotificationContentFileFormat'
          description: |-
            Indicate the format of report file to be generated by the engine.
            Used for `method` = *report-email* and *report-web*.
        internalData:
          type: array
          items:
            $ref: '#/components/schemas/type_:KeyValueDuo'
          description: >-
            Array of pairs key:value to insert in request body to target in
            **method** = *web* or *report-web*.
        reportName:
          $ref: '#/components/schemas/type_:NotificationContentReportName'
          description: >-
            The kind report to generate. For [automated
            reports](/developers/developer-guides/notifications-and-webhooks-overview#automated-reports)
            only.
        timeZone:
          $ref: '#/components/schemas/type_:Timezone'
        transactionId:
          type: string
          default: '0'
          description: >-
            Used internally to reference the entity or object generating the
            event.
        webHeaderParameters:
          type: array
          items:
            $ref: '#/components/schemas/type_:KeyValueDuo'
          description: >-
            Array of pairs key:value to insert in header of request to target in
            **method** = *web* or *report-web*.
    type_:CreatedAt:
      type: string
      format: date-time
    type_:Frequencynotification:
      type: string
      enum:
        - value: one-time
        - value: daily
        - value: weekly
        - value: biweekly
        - value: monthly
        - value: quarterly
        - value: semiannually
        - value: annually
        - value: untilcancelled
    type_:LastModified:
      type: string
      format: date-time
    type_:Methodnotification:
      type: string
      enum:
        - value: email
        - value: sms
        - value: web
        - value: report-email
        - value: report-web
    type_:NotificationId:
      type: integer
      format: int64
    type_:Ownerid:
      type: string
    type_:Ownertype:
      type: integer
    type_:Source:
      type: string
    type_:Statusnotification:
      type: integer
    type_:Target:
      type: string
    type_:QueryResponseNotificationsRecordsItem:
      type: object
      properties:
        content:
          $ref: '#/components/schemas/type_:NotificationContent'
          description: Notification content.
        createdAt:
          $ref: '#/components/schemas/type_:CreatedAt'
          description: Timestamp of when notification was created, in UTC.
        frequency:
          $ref: '#/components/schemas/type_:Frequencynotification'
        lastUpdated:
          $ref: '#/components/schemas/type_:LastModified'
          description: Timestamp of when notification was last updated, in UTC.
        method:
          $ref: '#/components/schemas/type_:Methodnotification'
        notificationId:
          $ref: '#/components/schemas/type_:NotificationId'
        ownerId:
          $ref: '#/components/schemas/type_:Ownerid'
        ownerName:
          type: string
          description: Name of entity owner of notification.
        ownerType:
          $ref: '#/components/schemas/type_:Ownertype'
        source:
          $ref: '#/components/schemas/type_:Source'
          description: Custom descriptor of source of notification.
        status:
          $ref: '#/components/schemas/type_:Statusnotification'
        target:
          $ref: '#/components/schemas/type_:Target'
    type_:PageIdentifier:
      type: string
    type_:Pagesize:
      type: integer
    type_:Totalrecords:
      type: integer
    type_:QuerySummary:
      type: object
      properties:
        pageIdentifier:
          $ref: '#/components/schemas/type_:PageIdentifier'
        pageSize:
          $ref: '#/components/schemas/type_:Pagesize'
        totalAmount:
          type: number
          format: double
          description: Total amount for the records.
        totalNetAmount:
          type: number
          format: double
          description: Total net amount for the records.
        totalPages:
          $ref: '#/components/schemas/type_:Totalrecords'
        totalRecords:
          $ref: '#/components/schemas/type_:Totalrecords'
    type_:QueryResponseNotifications:
      type: object
      properties:
        Records:
          type: array
          items:
            $ref: '#/components/schemas/type_:QueryResponseNotificationsRecordsItem'
        Summary:
          $ref: '#/components/schemas/type_:QuerySummary'

```

## SDK Code Examples

```python QueryResponseExample
from payabli import payabli

client = payabli(
    api_key="YOUR_API_KEY",
)
client.query.list_notifications(
    entry="8cfec329267",
    from_record=251,
    limit_record=0,
    sort_by="desc(field_name)",
)

```

```typescript QueryResponseExample
import { PayabliClient } from "@payabli/sdk-node";

const client = new PayabliClient({ apiKey: "YOUR_API_KEY" });
await client.query.listNotifications("8cfec329267", {
    fromRecord: 251,
    limitRecord: 0,
    sortBy: "desc(field_name)"
});

```

```go QueryResponseExample
import (
	context "context"
	option "github.com/payabli/sdk-go/option"
	sdkgo "github.com/payabli/sdk-go"
	sdkgoclient "github.com/payabli/sdk-go/client"
)

client := sdkgoclient.NewClient(
	option.WithApiKey(
		"<YOUR_ApiKey>",
	),
)
response, err := client.Query.ListNotifications(
	context.TODO(),
	"8cfec329267",
	&sdkgo.ListNotificationsRequest{
		FromRecord: sdkgo.Int(
			251,
		),
		LimitRecord: sdkgo.Int(
			0,
		),
		SortBy: sdkgo.String(
			"desc(field_name)",
		),
	},
)

```

```csharp QueryResponseExample
using PayabliApi;

var client = new PayabliApiClient("API_KEY");
await client.Query.ListNotificationsAsync(
    "8cfec329267",
    new ListNotificationsRequest
    {
        FromRecord = 251,
        LimitRecord = 0,
        SortBy = "desc(field_name)",
    }
);

```

```ruby QueryResponseExample
require 'uri'
require 'net/http'

url = URI("https://api-sandbox.payabli.com/api/Query/notifications/8cfec329267?fromRecord=251&limitRecord=0&sortBy=desc%28field_name%29")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["requestToken"] = '<apiKey>'

response = http.request(request)
puts response.read_body
```

```java QueryResponseExample
HttpResponse<String> response = Unirest.get("https://api-sandbox.payabli.com/api/Query/notifications/8cfec329267?fromRecord=251&limitRecord=0&sortBy=desc%28field_name%29")
  .header("requestToken", "<apiKey>")
  .asString();
```

```php QueryResponseExample
<?php

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://api-sandbox.payabli.com/api/Query/notifications/8cfec329267?fromRecord=251&limitRecord=0&sortBy=desc%28field_name%29', [
  'headers' => [
    'requestToken' => '<apiKey>',
  ],
]);

echo $response->getBody();
```

```swift QueryResponseExample
import Foundation

let headers = ["requestToken": "<apiKey>"]

let request = NSMutableURLRequest(url: NSURL(string: "https://api-sandbox.payabli.com/api/Query/notifications/8cfec329267?fromRecord=251&limitRecord=0&sortBy=desc%28field_name%29")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "GET"
request.allHTTPHeaderFields = headers

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```