Skip to main content
GET
/
api
/
partner
/
v2
/
receivers
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
  }
}
Retrieves all receivers for a specific user. Returns a paginated list of both INDIVIDUAL and BUSINESS receivers.

​
Error Codes

​
Common Errors

HTTP StatusCodeMessage
401UNAUTHORIZED”API Key is missing”
401UNAUTHORIZED”Invalid API Key format”
401UNAUTHORIZED”Invalid API Key”
403INVALID_PARTNER_FLOW”The partner has an invalid flow.”

​
User Ownership Errors

HTTP StatusCodeMessage
401UNAUTHORIZED”Partner information is required for this operation”
401UNAUTHORIZED”User is not associated with the partner”

​
Endpoint-Specific Errors

HTTP StatusCodeMessage
500RECEIVER_RETRIEVAL_FAILED”Failed to retrieve receivers. Please try again later.”

Headers

​
partner-api-key
string
required

Api key for the affiliated partner that is performing the request

Query Parameters

​
userId
string
required

User ID to filter receivers by owner

Example:

"550e8400-e29b-41d4-a716-446655440000"

Response

200 - application/json
​
success
boolean
Example:

true

​
data
object