Get all ambassadors (widget)

GET /widget/ambassadors

Headers

  • X-Popsell-Domain string Required

    The domain of the user

Query parameters

  • page integer

    page number

  • per_page integer

    number of items per page

  • filter[is_absent] boolean

    filter by is_absent

  • filter[unavailable] boolean

    filter by unavailable

  • sort string

    Sort by a specific field( for example: sort=distance&latitude=48.8566&longitude=2.3522)

    Values are distance or last_action_date.

  • latitude number

    latitude: required to sort by distance

  • longitude number

    longitude: required to sort by distance

Responses

  • 200 application/json

    returns all ambassadors (paginated)

    Hide response attributes Show response attributes object
    • current_page integer(int32)
    • data array[object]

      Additional properties are allowed.

    • first_page_url string
    • from integer(int32)
    • last_page integer(int32)
    • last_page_url string
    • links array[object]
      Hide links attributes Show links attributes object
      • url string(nullable)
      • label string
      • active boolean
    • next_page_url string
    • path string
    • per_page integer(int32)
    • prev_page_url string(nullable)
    • to integer(int32)
    • total integer(int32)
  • 401 application/json

    Unauthorized.

    Hide response attribute Show response attribute object
    • message string
GET /widget/ambassadors 
curl \
 --request GET 'https://domain.tld/api/v2/widget/ambassadors' \
 --header "X-Popsell-Domain: example.com"
Response examples (200) 
{
  "current_page": 42,
  "data": [
    {}
  ],
  "first_page_url": "string",
  "from": 42,
  "last_page": 42,
  "last_page_url": "string",
  "links": [
    {
      "url": "string",
      "label": "string",
      "active": true
    }
  ],
  "next_page_url": "string",
  "path": "string",
  "per_page": 42,
  "prev_page_url": "string",
  "to": 42,
  "total": 42
}
Response examples (401) 
{
  "message": "Unauthorized."
}