Get all Ambassador Posts

GET /{environment}/posts
Bearer token

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]

      Additional properties are allowed.

    • 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

GET /{environment}/posts 
curl \
 --request GET 'https://domain.tld/api/v2/widget/posts' \
 --header "Authorization: Bearer $ACCESS_TOKEN" \
 --header "X-Popsell-Domain: example.com"
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."
}