Query parameters

• sort string

  sort by a specific field

  Value is last_action_date.

• filter[name] string

  retrieve ambassadors by first name, last name, full name

• filter[ambassador_id_referrer] integer

  retrieve ambassadors by id referrer

• filter[active] integer

  Filter by active status (-3: unsubscribed by brand, -2: unsubscribed, -1: blocked, 0: unactivated, 1: active)

  Values are -5, -4, -3, -2, -1, 0, or 1.

• 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.

• page integer

  page number

• per_page integer

  number of items per page

Responses

• 200 application/json

  Returns all ambassadors (paginated)

  Hide response attributes Show response attributes 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]
    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
• 403

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