Get all referrers

GET 
/referrers

Get a list of all the custom referrers

Request

Query Parameters

paramsIO objectrequired

Responses

200

OK

*/*

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 stringrequired

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

• ]

Example (from schema)

[
  {
    "dateCreated": "2024-07-29T15:51:28.071Z",
    "detections": [
      {
        "and": true,
        "andMethod": "string",
        "andParameters": "string",
        "method": "string",
        "parameters": "string"
      }
    ],
    "id": 0,
    "index": 0,
    "modificationDate": "2024-07-29T15:51:28.071Z",
    "name": "string",
    "priority": 0,
    "siteId": 0,
    "tags": "string"
  }
]

400

Bad Request

*/*

Schema

Schema

code string
impersonator string
message string
name string
status string

Possible values: [SUCCESS, ERROR]

sub string
time int64
timestamp date-time

Example (from schema)

{
  "code": "string",
  "impersonator": "string",
  "message": "string",
  "name": "string",
  "status": "SUCCESS",
  "sub": "string",
  "time": 0,
  "timestamp": "2024-07-29T15:51:28.071Z"
}

403

Forbidden

*/*

Schema

Schema

code string
impersonator string
message string
name string
status string

Possible values: [SUCCESS, ERROR]

sub string
time int64
timestamp date-time

Example (from schema)

{
  "code": "string",
  "impersonator": "string",
  "message": "string",
  "name": "string",
  "status": "SUCCESS",
  "sub": "string",
  "time": 0,
  "timestamp": "2024-07-29T15:51:28.071Z"
}

423

Locked

*/*

Schema

Schema

code string
impersonator string
message string
name string
status string

Possible values: [SUCCESS, ERROR]

sub string
time int64
timestamp date-time

Example (from schema)

{
  "code": "string",
  "impersonator": "string",
  "message": "string",
  "name": "string",
  "status": "SUCCESS",
  "sub": "string",
  "time": 0,
  "timestamp": "2024-07-29T15:51:28.071Z"
}

500

Internal Server Error

*/*

Schema

Schema

code string
impersonator string
message string
name string
status string

Possible values: [SUCCESS, ERROR]

sub string
time int64
timestamp date-time

Example (from schema)

{
  "code": "string",
  "impersonator": "string",
  "message": "string",
  "name": "string",
  "status": "SUCCESS",
  "sub": "string",
  "time": 0,
  "timestamp": "2024-07-29T15:51:28.071Z"
}

Loading...