Get all referrers

Get a list of all the custom referrers

Query Parameters

• paramsIO object required

Responses

• 200
• 400
• 403
• 423
• 500

---

OK

*/*

• Schema
• Example (from schema)

---

Schema

• Array [
• dateCreated date-time

  Date and time referred is created

• detections object[]

  Array [

  and boolean

  andMethod string

  andParameters string

  method string

  parameters string

  ]
• id int64

  Unique identifier of the given referrer

• index int32

  Index of the referrer

• modificationDate date-time

  Date and time referred is modified

• name string required

  Name of the referrer

• priority int32

  Priority for the given referrer

• siteId int64

  Unique site identifier associated with the referrer

• tags string

  Tags associated with the given referrer

• ]

[
  {
    "dateCreated": "2024-12-20T15:04:33.292Z",
    "detections": [
      {
        "and": true,
        "andMethod": "string",
        "andParameters": "string",
        "method": "string",
        "parameters": "string"
      }
    ],
    "id": 0,
    "index": 0,
    "modificationDate": "2024-12-20T15:04:33.292Z",
    "name": "string",
    "priority": 0,
    "siteId": 0,
    "tags": "string"
  }
]

Bad Request

*/*

• Schema
• Example (from schema)

---

Schema

• code string
• impersonator string
• message string
• name string
• status string

  Possible values: [SUCCESS, ERROR]

• sub string
• time int64
• timestamp date-time

{
  "code": "string",
  "impersonator": "string",
  "message": "string",
  "name": "string",
  "status": "SUCCESS",
  "sub": "string",
  "time": 0,
  "timestamp": "2024-12-20T15:04:33.293Z"
}

Forbidden

*/*

• Schema
• Example (from schema)

---

Schema

• code string
• impersonator string
• message string
• name string
• status string

  Possible values: [SUCCESS, ERROR]

• sub string
• time int64
• timestamp date-time

{
  "code": "string",
  "impersonator": "string",
  "message": "string",
  "name": "string",
  "status": "SUCCESS",
  "sub": "string",
  "time": 0,
  "timestamp": "2024-12-20T15:04:33.293Z"
}

Locked

*/*

• Schema
• Example (from schema)

---

Schema

• code string
• impersonator string
• message string
• name string
• status string

  Possible values: [SUCCESS, ERROR]

• sub string
• time int64
• timestamp date-time

{
  "code": "string",
  "impersonator": "string",
  "message": "string",
  "name": "string",
  "status": "SUCCESS",
  "sub": "string",
  "time": 0,
  "timestamp": "2024-12-20T15:04:33.293Z"
}

Internal Server Error

*/*

• Schema
• Example (from schema)

---

Schema

• code string
• impersonator string
• message string
• name string
• status string

  Possible values: [SUCCESS, ERROR]

• sub string
• time int64
• timestamp date-time

{
  "code": "string",
  "impersonator": "string",
  "message": "string",
  "name": "string",
  "status": "SUCCESS",
  "sub": "string",
  "time": 0,
  "timestamp": "2024-12-20T15:04:33.293Z"
}

Loading...