# Get all ambassadors

**GET /chat/ambassadors**




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


## Authentication methods
- Bearer token


## Parameters
### Headers
- **X-Popsell-Brand** (integer)
  The id of the target brand


### Query parameters
- **sort** (string)
  Sort chatrooms by one of the following fields
- **filter[brand_tag]** (integer)
  retrieve ambassadors by brand tag id
- **filter[name]** (string)
  retrieve ambassadors by first name, last name or username
- **filter[status]** (integer)
  Filter by ambassador status (0: ambassador, 1: employee, 2: administrator, 3: seller, 4: shop manager, 5: manager, 6: expert, 7: client, 8: temp) ex: ?filter[status]=7,8 will return ambassadors with status client or temp
- **filter[social_community_display]** (integer)
  Filter by social community display (0: hidden, 1: visible)
- **filter[exclude]** (integer)
  Exclude ambassadors by id


## 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))


### 401
Unauthorized.

#### Body: application/json (object)
- **message** (string)


### 403
Forbidden - You don't have permission to access this route


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