cURL
curl --request GET \ --url https://staging-api.capa.fi/api/partner/v2/receivers \ --header 'partner-api-key: <partner-api-key>'
{ "success": true, "data": { "data": [ { "id": "9486244c-ff7d-4c22-9984-797179d7deaa", "userId": "<string>", "receiverType": "INDIVIDUAL", "email": "<string>", "disabled": false, "createdAt": "<string>", "updatedAt": "<string>" } ], "count": 5, "total": 5 } }
userId
Api key for the affiliated partner that is performing the request
User ID to filter receivers by owner
"550e8400-e29b-41d4-a716-446655440000"
true
Show child attributes
List of receivers
Receiver ID
"9486244c-ff7d-4c22-9984-797179d7deaa"
User ID who created this receiver
Type of receiver
INDIVIDUAL
BUSINESS
"INDIVIDUAL"
Email address
Whether receiver is disabled
false
Creation timestamp
Last update timestamp
Number of receivers in the current response
5
Total number of receivers for the user