Get all ambassadors with pertinence search (manager)

GET /manager/ambassadors/micro-resource

Query parameters

  • 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

    Values are 0, 1, 2, 3, 4, 5, 6, 7, or 8.

Responses

  • 200 application/json

    Returns matching 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
    • 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
  • 403

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

GET /manager/ambassadors/micro-resource
curl \
 --request GET 'https://domain.tld/api/v2/manager/ambassadors/micro-resource' \
 --header "Authorization: Bearer $ACCESS_TOKEN"
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."
}