GET
/
api
/
v1
/
referral_users
{
  "hydra:member": [
    {
      "@context": "<string>",
      "@id": "<string>",
      "@type": "<string>",
      "id": 123,
      "referral": {
        "@context": "<string>",
        "@id": "<string>",
        "@type": "<string>",
        "hash": "<string>",
        "id": 123,
        "user": {
          "@context": "<string>",
          "@id": "<string>",
          "@type": "<string>",
          "id": 123,
          "firstName": "<string>",
          "lastName": "<string>",
          "logo": "<string>"
        },
        "dateCreated": "2023-11-07T05:31:56Z",
        "status": "AWAITING_REFERRAL"
      },
      "user": {
        "@context": "<string>",
        "@id": "<string>",
        "@type": "<string>",
        "id": 123,
        "firstName": "<string>",
        "lastName": "<string>",
        "logo": "<string>"
      },
      "dateCreated": "2023-11-07T05:31:56Z",
      "referralReason": "<string>",
      "answer1": "<string>",
      "answer2": "<string>",
      "answer3": "<string>"
    }
  ],
  "hydra:totalItems": 1,
  "hydra:view": {
    "@id": "string",
    "type": "string",
    "hydra:first": "string",
    "hydra:last": "string",
    "hydra:previous": "string",
    "hydra:next": "string"
  },
  "hydra:search": {
    "@type": "<string>",
    "hydra:template": "<string>",
    "hydra:variableRepresentation": "<string>",
    "hydra:mapping": [
      {
        "@type": "<string>",
        "variable": "<string>",
        "property": "<string>",
        "required": true
      }
    ]
  }
}

Query Parameters

page
integer
default:1

The collection page number

pagination
boolean

Enable or disable pagination

user
string
user[]
string[]
referral.user
string
referral.user[]
string[]

Response

200
application/ld+json

ReferralUser collection

The response is of type object.