v1

latestOpenAPI 3.1.02026-07-24540259.7 KB

beneficiariesPage

The beneficiariesPage query fetches all beneficiaries that belong to your organization paginated by the specified pages and search filters.

post/graphql (19 disregard)

Request body

querystring

Response

200

Example response

{
  "data": {
    "beneficiariesPage": {
      "items": [
        {
          "id": "dc3c90af-6311-4fb3-973f-cd7b273080b8",
          "entity": {
            "id": "d8882fb0-0469-48e0-8e8a-ef31ae391cd1",
            "type": "personal",
            "first_name": "John",
            "last_name": "Doe",
            "state": "verified",
            "email": "test@entity.com",
            "phone": "9149999999",
            "phone_country": "US",
            "address1": "1305 e 6th st.",
            "city": "Austin",
            "state_province_region": "TX",
            "postal_code": "78703",
            "country": "US"
          },
          "creator": {
            "id": "bec28c73-046b-4366-9e2c-cf043bc2e196",
            "identifier": "demo@routefusion.com",
            "email": "demo@routefusion.com",
            "first_name": "Gilligan",
            "last_name": "Denver",
            "admin": true
          },
          "type": "business",
          "email": "test@test.com",
          "address1": "1001 20 Avenue",
          "city": "didsbury",
          "state_province_region": "AB",
          "postal_code": "T0M 0W0",
          "country": "CA",
          "business_name": "NorthStar Academy Canada",
          "swift_bic": "BNDCCAMM",
          "account_number": "13451345",
          "routing_code": "123456789",
          "currency": "CAD",
          "bank_name": "Bank of Canada - Banque du Canada",
          "bank_address1": "234 Wellington Street West",
          "bank_city": "ottawa",
          "bank_state_province_region": "ON",
          "bank_postal_code": "K1A 0G9",
          "bank_country": "CA"
        }
      ]
    }
  }
}