Get referral's info

GET 
/referral

Get referral's info

Request

Responses

200

Get referral's info.

application/json

Schema

Schema

referrer

object

username string

cognitoUserId string

referralCode string

avatar url

referees

object[]

Array [

cognitoUserId string

username string

avatar url

]

Example (from schema)

{
  "referrer": {
    "username": "Marwan",
    "cognitoUserId": "6c3f1279-8b65-4bc4-bac3-20502fdfd4a8e",
    "referralCode": "dnjd4n1",
    "avatar": "https:/file.playmakers.co/avatar.png"
  },
  "referees": [
    {
      "cognitoUserId": "9434knf-8b65-4bc4-bac3-20502fdfd4a8e",
      "username": "Latifa",
      "avatar": "https:/file.playmakers.co/avatar.png"
    }
  ]
}

400

Bad Request

application/json

Schema

Schema

error string

Example (from schema)

{
  "error": "string"
}

Example

{
  "error": "Bad Request"
}

401

Unauthorized

application/json

Schema

Schema

error string

Example (from schema)

{
  "error": "string"
}

Example

{
  "error": "Unauthorized access"
}

403

Forbidden

application/json

Schema

Schema

error string

Example (from schema)

{
  "error": "string"
}

Example

{
  "error": "Forbidden access"
}

500

Internal Server Error

application/json

Schema

Schema

error string

Example (from schema)

{
  "error": "string"
}

Example

{
  "error": "Internal Server Error"
}

default

Unexpected error

application/json

Schema

Schema

error string

Example (from schema)

{
  "error": "string"
}

Example

{
  "error": "An unexpected error occured"
}

Loading...