Referencia de APIAccounting / Beneficiary
Get Beneficiary
← Back to full API reference
GET
/v1/beneficiaryAuth requiredRequest details
Query params
| Field | Required | Description |
|---|---|---|
| contactIds | Yes | Inferred from req.query.contactIds |
| notContactIds | Yes | Inferred from req.query.notContactIds |
| withContacts | Yes | Inferred from req.query.withContacts |
| withTaxData | Yes | Inferred from req.query.withTaxData |
| type | Yes | Inferred from req.query.type |
| minId | Yes | Inferred from req.query.minId |
| search | Yes | Inferred from req.query.search |
| elementsPerPage | Yes | Inferred from req.query.elementsPerPage |
| subscribed | Yes | Inferred from req.query.subscribed |
| subscribedDivisionId | Yes | Inferred from req.query.subscribedDivisionId |
| subscribedDivisionMethod | Yes | Inferred from req.query.subscribedDivisionMethod |
| contactDataType | Yes | Inferred from req.query.contactDataType |
| contactDataField | Yes | Inferred from req.query.contactDataField |
| contactDataMethod | Yes | Inferred from req.query.contactDataMethod |
| contactDataValue | Yes | Inferred from req.query.contactDataValue |
| includeArchived | Yes | Inferred from req.query.includeArchived |
Default payloads
Path params
json
{}Query
json
{
"contactIds": "string",
"notContactIds": "string",
"withContacts": "string",
"withTaxData": "string",
"type": "string",
"minId": "string",
"search": "string",
"elementsPerPage": "string",
"subscribed": "string",
"subscribedDivisionId": "string",
"subscribedDivisionMethod": "string",
"contactDataType": "string",
"contactDataField": "string",
"contactDataMethod": "string",
"contactDataValue": "string",
"includeArchived": "string"
}Sample response
json
"<result>"