Referencia de APIAccounting / Beneficiary Get Beneficiary
GET /v1/beneficiary • typed through route generics
← Back to full API referenceGET/v1/beneficiaryAuthentication required
Request details
Path params
No path parameters for this endpoint.
Query params
contactIds (required)
Inferred from req.query.contactIds
notContactIds (required)
Inferred from req.query.notContactIds
withContacts (required)
Inferred from req.query.withContacts
withTaxData (required)
Inferred from req.query.withTaxData
type (required)
Inferred from req.query.type
minId (required)
Inferred from req.query.minId
search (required)
Inferred from req.query.search
elementsPerPage (required)
Inferred from req.query.elementsPerPage
subscribed (required)
Inferred from req.query.subscribed
contactDataType (required)
Inferred from req.query.contactDataType
contactDataField (required)
Inferred from req.query.contactDataField
contactDataMethod (required)
Inferred from req.query.contactDataMethod
contactDataValue (required)
Inferred from req.query.contactDataValue
includeArchived (required)
Inferred from req.query.includeArchived
Body fields
No body payload expected for GET endpoints.
Default payloads
Query
{
"contactIds": "string",
"notContactIds": "string",
"withContacts": "string",
"withTaxData": "string",
"type": "string",
"minId": "string",
"search": "string",
"elementsPerPage": "string",
"subscribed": "string",
"contactDataType": "string",
"contactDataField": "string",
"contactDataMethod": "string",
"contactDataValue": "string",
"includeArchived": "string"
}
Test this endpoint now
Use your own credentials and execute a live request directly from this page.
2. Select endpoint
GET/v1/beneficiaryAuthentication required
Group: Accounting / Beneficiary
GET /v1/beneficiary • typed through route generics
Query params
- contactIdsrequired
Inferred from req.query.contactIds
- notContactIdsrequired
Inferred from req.query.notContactIds
- withContactsrequired
Inferred from req.query.withContacts
- withTaxDatarequired
Inferred from req.query.withTaxData
- typerequired
Inferred from req.query.type
- minIdrequired
Inferred from req.query.minId
- searchrequired
Inferred from req.query.search
- elementsPerPagerequired
Inferred from req.query.elementsPerPage
- subscribedrequired
Inferred from req.query.subscribed
- contactDataTyperequired
Inferred from req.query.contactDataType
- contactDataFieldrequired
Inferred from req.query.contactDataField
- contactDataMethodrequired
Inferred from req.query.contactDataMethod
- contactDataValuerequired
Inferred from req.query.contactDataValue
- includeArchivedrequired
Inferred from req.query.includeArchived
3. Prepare request payload
4. Server response
Run a request to inspect the real-time response for your environment.