Sign in

v1

latestOpenAPI 3.1.0© Copyright Partoo2026-07-26163503484.0 KB
Posts

Search for post

This endpoint lets you browse through all your posts.

get/posts

Query parameters

business__inBusinessId[]

Filter by business ids. Use a comma-separated list to provide multiple ids.

[
  "5409c35a97bbc544d8e26737"
]
start_datetimestring
Example:2020-11-06T23:59:59

Filters Posts based on their start datetime.

The start datetime represents the moment on which a Post of type event/offer will become available. In case of Posts of type news, the start_datetime it will be compare to the creation date of the Post, as the field is not present in this context.

end_datetimestring
Example:2020-11-06T23:59:59

Filter Posts based on their end datetime.

The end datetime represents the date on which the Post of type event/offer will expire. In case of Posts of type news, the end_datetime it will be compare to exactly one week after the creation date of the Post, as the field is not present in this context.

summarystring

Filter Posts based on their description.

It returns Posts that contain in their description the given string. The text does not have to match perfectly.

state__in'live' | 'to_configure' | 'pending' | 'scheduled' | 'error' | 'expired' | 'to_validate'

Filter Posts based on its state.

topic_type'standard' | 'event' | 'offer' | 'alert'

Filter Posts based on its type.

topic_type__in'standard' | 'event' | 'offer' | 'alert'

Filter Posts based on a list of different types.

pageinteger

Page number. Starts at 1. Any value lower than 1 will be considered as 1. For the number of items per page, see the per_page query parameter.

per_pageinteger

Number of items to return per page. Currently limited to 100.

Response

OK

pageinteger

Current page number

max_pageinteger

Last page number

countinteger

Number of resources complying with filters

Example response

{
  "page": 1,
  "max_page": 10,
  "count": 287,
  "posts": [
    {
      "id": 34,
      "business_id": "5409c35a97bbc544d8e26737",
      "summary": "Wonderful post summary !",
      "schedule_time": "2020-01-01T12:00:00+02:00",
      "expiration_time": "2020-01-01T12:00:00+02:00",
      "validation_time": "2020-01-01T12:00:00+02:00",
      "created_at": "2019-08-01T19:15:54.256000+02:00",
      "updated_at": "2019-09-01T15:12:35.256000+02:00",
      "business_info": "Rick - HQ - 157 boulevard Macdonald, Paris",
      "post_insight": [
        {
          "name": "facebook__posts",
          "click_count": 1512,
          "view_count": 2012
        }
      ],
      "post_status": [
        {
          "name": "facebook__posts",
          "state": "live",
          "link": "www.partoo.co"
        }
      ],
      "offer_terms": "These are the conditions",
      "offer_code": "PROMO25",
      "cta_link": "www.partoo.co"
    }
  ]
}