NOnotchpay

List all beneficiaries

Changed on
get/beneficiaries

Request

  • Base URL
    https://api.notchpay.co
  • URL
    https://api.notchpay.co/beneficiaries
  • Auth
    • API key in header Authorization
    • or API key in header X-Grant
    • or API key in header X-Sync

Query parameters

limitinteger

Number of items per page

pageinteger

Page number

searchstring

Search by name or email

Response

Successful response

codeinteger required
statusstring required
messagestring required
totalsinteger
last_pageinteger
current_pageinteger
selectedinteger
itemsBeneficiary[] required(unresolved $ref)

Changes

  • 171d0769b265Revision changes
    • breaking

      the response's body type changed from no type to object for status

    • breaking

      the response's body type changed from no type to object for status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status