Return all the guests for a site accepts the format ?page=1&per_page=10&search=&fromdate=&todate=

GET /ext/{siteid}/api/v1/guest/
Api key auth

date should be in DD-MM-YYYY format

Headers

  • X-Fields string(mask)

    An optional fields mask

Path parameters

  • siteid string Required

    Site database ID

Query parameters

  • todate string

    Guests created until date in DD-MM-YYYY format

  • fromdate string

    Guests created from date in DD-MM-YYYY format

  • per_page string

    Number of entries per page

  • page string

    Page Number

Responses

  • 200 application/json

    Success

    Hide response attributes Show response attributes object
    • metadata object
    • items array[object]
      Hide items attributes Show items attributes object
      • last_seen_at string(date-time)

        Last Seen At

      • email string

        Email

      • consent boolean

        Consent

      • phonenumber string

        Phonenumber

      • newsletter boolean

        Consent

      • name object

        Firstname

      • id integer
GET /ext/{siteid}/api/v1/guest/ 
curl \
 --request GET 'http://api.example.com/ext/{siteid}/api/v1/guest/' \
 --header "Authentication-Token: $API_KEY" \
 --header "X-Fields: string"
Response examples (200) 
{
  "metadata": {},
  "items": [
    {
      "last_seen_at": "2025-05-04T09:42:00Z",
      "email": "string",
      "consent": true,
      "phonenumber": "string",
      "newsletter": true,
      "name": {},
      "id": 42
    }
  ]
}