Query parameters

• sort string

  example :to sort the ambassadors by firstname (-firstname: descending, firstname: ascending)

  Values are id_ambassador, firstname, lastname, customer_id, email, active, status, date_insert, gamification_score, sell_token_amount, nb_conversations, nb_diffused_publications, nb_sales, nb_chat_sales, nb_purchases, or pertinence.

• filter[ambassador_search] string

  retrieve ambassadors by first name, last name,full name, email, email tmp, customer id.

• filter[has_role] string

  Filter by roles

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

• filter[suspicious] boolean

  Filter by suspicious status (true/false)

• filter[quarantine] boolean

  Filter by quarantine status (true/false)

• filter[manager_users_only] string

  if set to true , only manager users will be returned

• 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]
    Hide data attributes Show data attributes object

    • id_ambassador integer(int32)
    • id_brand integer(int32)
    • date_insert string
    • customer_id string
    • image string
    • gender string
    • firstname string
    • lastname string
    • username string
    • email string
    • email_tmp string
    • gamification_score integer(int32)
    • suspicious boolean
    • suspicious_date string
    • ignore_suspicious boolean
    • suspicious_quarantine boolean
    • active integer(int32)
    • status integer(int32)
    • sell_token_amount integer(int32)
    • nb_conversations integer(int32)
    • nb_diffused_publications integer(int32)
    • online boolean

      true: when last_action_date is less than 5 minutes ago

    • sponsor integer(int32)
    • nb_sales integer(int32)
    • nb_chat_sales integer(int32)
    • nb_purchases integer(int32)
    • role array[string]
    • anonymized boolean
  • 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