# Get all ambassadors (widget)

**GET /widget/ambassadors**




## Servers
- https://domain.tld/api/v2: https://domain.tld/api/v2 ()



## Parameters
### Headers
- **X-Popsell-Domain** (string)
  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
- **filter[last_action_date_after]** (string(date-time))
  filter by last_action_date
- **filter[online_only]** (boolean)
  return only ambassadors who are online
- **sort** (string)
  Sort by a specific field( for example: sort=distance&latitude=48.8566&longitude=2.3522)
- **latitude** (number)
  latitude: required to sort by distance
- **longitude** (number)
  longitude: required to sort by distance


## Responses
### 200
returns all ambassadors (paginated)

#### Body: application/json (object)
- **current_page** (integer(int32))

- **data** (array[object])

- **first_page_url** (string)

- **from** (integer(int32))

- **last_page** (integer(int32))

- **last_page_url** (string)

- **links** (array[object])

- **next_page_url** (string)

- **path** (string)

- **per_page** (integer(int32))

- **prev_page_url** (string(nullable))

- **to** (integer(int32))

- **total** (integer(int32))



[Powered by Bump.sh](https://bump.sh)