entityBeneficiaries

The beneficiary query fetches a single beneficiary.

Parameters

ParameterTypeRequired
entity_idUUIDtrue
listFilterObjectfalse

GraphQL Query

query entityBeneficiaries (
    $entity_id: UUID!
    $search_terms: String
    $listFilter: ListFilter
) {
    entityBeneficiaries (
        entity_id: $entity_id
        search_terms: $search_terms
        listFilter: $listFilter
    ) {
        id
        entity {
            id
            type
            state
            business_name
            first_name
            last_name
            state
            email
            phone
            address1
            address2
            city
            state_province_region
            postal_code
            country
        }
        creator {
            id
            identifier
            email
            first_name
            last_name
            admin
        }
        type
        email
        phone
        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
    }
}
Language
Click Try It! to start a request and see the response here!