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
  }
}
Lists receivers for a given userId.

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