Getting a users referrals

The result output is a JSON array with its results section being something to the lines of the following:

{
    "result": {
        "code": 1,
        "status": "ok"
    },
    "results": {
        "referrals": [
            {
                "referred_user": {
                    "user_id": 7,
                    "initials": "John S",
                    "created_date": "2021-08-04 12:07:52"
                },
                "referring_user": {
                    "user_id": 4
                }
            },
            {
                "referred_user": {
                    "user_id": 6,
                    "initials": "Jane S",
                    "created_date": "2021-08-04 12:07:51"
                },
                "referring_user": {
                    "user_id": 4
                }
            }
        ],
        "count": 2,
        "result_type": "get-campaign-referrals"
    }
}

• Call name: get-campaign-referrals
• Endpoint URL: https://apistage0.spaaza.com/get-campaign-referrals
• Request methods: GET
• Response Content-Type: application/json
• Auth required: yes

Get the number of referrals by a referring user as well as a partially obfuscated list of referred users.

HTTP Parameters

The following HTTP parameters can be passed to the API:

Permissions and Authentication

This API call requires a valid Spaaza session. The session can be as follows:

• User authentication: a session generated by an end-user login.
• Admin authentication: the performing user needs to be logged in and have read access to the entity (business or chain) to which the user is connected.
• Privileged authentication: the use of privileged authentication is permitted for this endpoint.

Headers

The following headers can/must be passed to the API call:

Permissions

This API call requires no specific permissions.

Possible error responses

The following represents a list of possible error responses for the get-card endpoint: