Headers

• X-Popsell-Domain string Required

  The domain of the user

Path parameters

• environment string Required

  The environment

  Values are widget or manager.

Query parameters

• page integer

  page number

• per_page integer

  number of items per page

• sort string

  example :to sort the ambassador posts by date_insert (-date_insert: descending, date_insert: ascending)

  Values are shares_count, date_insert, date_update, date_post, active, orders_count, or type.

• filter[id_ambassador] string

  Filter by ambassador id

• filter[ambassador_post_search] string

  filter by ambassador post search

• filter[view_on_blog] boolean

  filter by view_on_blog

• filter[type] string

  filter by type

  Values are POST or POPLISTE.

• filter[visibility] string

  filter by visibility

  Values are FOLLOWERS, LIVE, ME, or PUBLIC.

• filter[is_brand] boolean

  filter by is_brand

• filter[status] boolean

  filter by status

• filter[is_planned] boolean

  filter by is_planned

Responses

• 200 application/json

  returns all posts (paginated)

  Hide response attributes Show response attributes object

  • current_page integer(int32)
  • data array[object]
    Hide data attributes Show data attributes object

    • id_ambassador_post integer(int32)
    • id_ambassador_post_shared integer(int32)
    • date_post string(date-time)
    • date_insert string(date-time)
    • date_update string(date-time)
    • author object

      Additional properties are allowed.

      Hide author attributes Show author attributes object

      • id_ambassador integer(int32)
      • image string
      • firstname string
      • lastname string
      • username string
      • email string
      • email_tmp string
      • active integer(int32)
      • status integer(int32)
      • online boolean

        true: when last_action_date is less than 5 minutes ago

      • last_action_date string(date-time)
      • customer_id string
      • anonymized boolean
    • type string(nullable)
    • content string(nullable)
    • nb_likes integer(int32)
    • nb_comments integer(int32)
    • visibility string(nullable)
    • view_on_blog boolean
    • products array[object]
      Hide products attributes Show products attributes object

      • id_product integer(int32)
      • name string(nullable)
      • type string(nullable)
      • discount_percentage number(float)
      • price_catalog integer(float)
      • reference_unit_price integer(float)
      • sku string(nullable)
      • youtube_id string(nullable)
      • url string(nullable)
      • description string(nullable)
      • images array[object]
        Hide images attributes Show images attributes object

        • id_i18n_content integer
        • lang string

          Values are en_GB, fr_FR, es_ES, or de_DE.

        • content string
      • price number(float)
      • stock integer(float)
      • stock_available number(float)
      • old_image string(nullable)
    • comments array[object]
      Hide comments attributes Show comments attributes object

      • id_ambassador_post integer(int32)
      • author object

        Additional properties are allowed.

        Hide author attributes Show author attributes object

        • id_ambassador integer(int32)
        • image string(nullable)
        • full_name string
        • username string(nullable)
        • description string
        • status integer(int32)
        • availability string(nullable)
        • unavailable boolean
        • is_absent boolean
        • absent_msg string(nullable)
        • fb_account string(nullable)
        • twitter_account string(nullable)
        • instagram_account string(nullable)
        • linkedIn_account string(nullable)
        • youtube_account string(nullable)
        • online boolean

          true: when last_action_date is less than 5 minutes ago

        • last_action_date string
        • location string

          Label of the point of sale, or city of the ambassador

      • content string(nullable)
      • nb_likes integer(int32)
      • comments array[object]

        Additional properties are allowed.

      • date_created string(date-time)
      • date_timestamp boolean
      • liked boolean
    • videos array[object]
      Hide videos attributes Show videos attributes object

      • id_video integer
      • date_insert string(date-time)
      • date_update string(date-time)
      • date_delete string(date-time)
      • id_blob string
      • state integer

        Values are 0, 1, 2, or 3.

    • nb_orders integer(int32)
    • liked boolean
    • contents array[object]
      Hide contents attributes Show contents attributes object

      • id_i18n_content integer
      • lang string

        Values are en_GB, fr_FR, es_ES, or de_DE.

      • content string
    • titles array[object]
      Hide titles attributes Show titles attributes object

      • id_i18n_content integer
      • lang string

        Values are en_GB, fr_FR, es_ES, or de_DE.

      • content string
    • is_planned boolean
    • shares integer(int32)
    • status string(nullable)
    • is_brand boolean
    • is_akn boolean
    • link number
    • data1 string
    • data2 string
    • thread_last_update string(date-time)
    • start_date string(date-time)
    • is_on_boarding boolean
    • is_welcome boolean
    • shareable boolean
    • no_comment boolean
    • id_popliste number
  • 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