Get all Guestusers

View as markdown
GET /ext/{siteid}/api/v1/guestuser/
Api key auth

Accepts the format /ext/{siteid}/api/v1/guestuser/?page=1&per_page=10&search=

Path parameters

  • siteid string Required

    Site database ID

Query parameters

  • page integer

    Page number

  • per_page integer

    Number of items per page

Responses

  • 200 application/json

    Success

    Hide response attributes Show response attributes object
    • metadata object
      Hide metadata attributes Show metadata attributes object
      • total integer

        Total number of items

      • page integer

        Current page number

      • per_page integer

        Items per page

      • pages integer

        Total number of pages

    • items array[object]
      Hide items attributes Show items attributes object
      • unlimited_speed boolean

        Set speed to be unlimited for guestuser

      • id integer
      • status object

        Guest account status [unused|inuse|expired]

      • num_devices integer Required

        Max devices allowed in this package

      • unlimited_data boolean

        Set data to be unlimited for guestuser

      • name object

        Guest name

      • duration_val integer Required

        Allowed duration actual value

      • duration_type integer Required

        Type for time duration (1,'Minutes'),(2,'Hours'),(3,'Days')

      • speed_dl integer

        Download speed , 0 for unlimited ( only if speed_limit is True)

      • auths array[object]
        Hide auths attributes Show auths attributes object
        • id integer
        • type string
        • devicedata object
        • mac object
        • last_seen_at object
        • online object
        • time_used string
        • data_used string
        • hostname object
      • bytes_t integer

        Data Limit ( only if data_limit is True)

      • bytes_type integer

        Data Limit type (1,'Total'),(2,'Daily'),(3,'Weekly'),(4,'Monthly') ( only if data_limit is True)

      • email string

        Email

      • username string Required

        username

      • notes string

        Internal comments

      • speed_ul integer

        Upload speed , 0 for unlimited ( only if speed_limit is True)
GET /ext/{siteid}/api/v1/guestuser/ 
curl \
 --request GET 'https://api.spotipo.com/ext/{siteid}/api/v1/guestuser/' \
 --header "Authentication-Token: $API_KEY"
Response examples (200) 
{
  "metadata": {
    "total": 42,
    "page": 42,
    "per_page": 42,
    "pages": 42
  },
  "items": [
    {
      "unlimited_speed": true,
      "id": 42,
      "status": {},
      "num_devices": 42,
      "unlimited_data": true,
      "name": {},
      "duration_val": 42,
      "duration_type": 42,
      "speed_dl": 42,
      "auths": [
        {
          "id": 42,
          "type": "string",
          "devicedata": {},
          "mac": {},
          "last_seen_at": {},
          "online": {},
          "time_used": "string",
          "data_used": "string",
          "hostname": {}
        }
      ],
      "bytes_t": 42,
      "bytes_type": 42,
      "email": "string",
      "username": "string",
      "notes": "string",
      "speed_ul": 42
    }
  ]
}