beneficiariesPage
Parameters
| Parameter | Type | Required |
|---|---|---|
| search_terms | String | false |
| pagination | PaginationInput | true |
| filters | [FilterInput] | false |
query
string
Defaults to {}
```
200
object
data
object
beneficiariesPage
object
beneficiariesPage object
# ```
400
var axios = require('axios');
var data = JSON.stringify({
query: `query beneficiariesPage ($search_terms: String, pagination: PaginationInput!, filters: [FilterInput]) {
beneficiariesPage (search_terms: $search_terms, pagination: $pagination, filters: $filters) {
items {
id
entity {
id
}
creator {
id
}
type
email
phone
phone_country
tax_number
first_name
last_name
address1
address2
city
state_province_region
postal_code
country
contact_first_name
contact_last_name
business_name
name_on_bank_account
swift_bic
account_number
routing_code
currency
bank_name
branch_name
bank_address1
bank_address2
bank_city
bank_state_province_region
bank_postal_code
bank_country
}
}
}`,
variables: { "pagination": { "page": 1, "page_size": 20 }, "filters": [{ "key": "country", "values": ["US"] }] }
});
var config = {
method: 'post',
url: 'https://sandbox.external.routefusion.com/graphql',
headers: {
'Authorization': 'Bearer <your token>',
'Content-Type': 'application/json'
},
data : data
};
axios(config)
.then(function (response) {
console.log(JSON.stringify(response.data));
})
.catch(function (error) {
console.log(error);
});
{
"data": {
"beneficiariesPage": {
"items": [
{
"id": "dc3c90af-6311-4fb3-973f-cd7b273080b8",
"entity": {
"id": "d8882fb0-0469-48e0-8e8a-ef31ae391cd1",
"type": "personal",
"business_name": null,
"first_name": "John",
"last_name": "Doe",
"state": "verified",
"email": "test@entity.com",
"phone": "9149999999",
"phone_country": "US",
"address1": "1305 e 6th st.",
"address2": "",
"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",
"phone": "",
"phone_country": "",
"tax_number": "",
"first_name": null,
"last_name": null,
"address1": "1001 20 Avenue",
"address2": "",
"city": "didsbury",
"state_province_region": "AB",
"postal_code": "T0M 0W0",
"country": "CA",
"contact_first_name": null,
"contact_last_name": null,
"business_name": "NorthStar Academy Canada",
"name_on_bank_account": null,
"swift_bic": "BNDCCAMM",
"account_number": "13451345",
"routing_code": "123456789",
"currency": "CAD",
"bank_name": "Bank of Canada - Banque du Canada",
"branch_name": null,
"bank_address1": "234 Wellington Street West",
"bank_address2": "",
"bank_city": "ottawa",
"bank_state_province_region": "ON",
"bank_postal_code": "K1A 0G9",
"bank_country": "CA"
},
{
"id": "c5e0802a-d6ec-4062-838d-a9bd3c28a1b1",
"entity": {
"id": "d8882fb0-0469-48e0-8e8a-ef31ae391cd1",
"type": "personal",
"business_name": null,
"first_name": "John",
"last_name": "Doe",
"state": "verified",
"email": "test@entity.com",
"phone": "9149999999",
"phone_country": "US",
"address1": "1305 e 6th st.",
"address2": "",
"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@bene.com",
"phone": "",
"phone_country": "",
"tax_number": "",
"first_name": null,
"last_name": null,
"address1": "12001 Metric Boulevard",
"address2": "",
"city": "Austin",
"state_province_region": "TX",
"postal_code": "78758",
"country": "US",
"contact_first_name": null,
"contact_last_name": null,
"business_name": "Northstar Apartments",
"name_on_bank_account": null,
"swift_bic": null,
"account_number": "235423542345",
"routing_code": "134553443",
"currency": "USD",
"bank_name": "Citibank",
"branch_name": null,
"bank_address1": "38-17 Main Street",
"bank_address2": "",
"bank_city": "",
"bank_state_province_region": "NY",
"bank_postal_code": "11354",
"bank_country": "US"
}
]
}
}
}