publications

Retrieve list of publications

Retrieve all publications of the organization (paginated)

get/organizations/{id_organization}/publish

Request

  • Base URL: https://api.planvortex.com/v1.0.0
  • URL: https://api.planvortex.com/v1.0.0/organizations/{id_organization}/publish
  • Auth: one of:
    • HTTP bearer
    • OAuth 2 (client credentials, token URL https://api.planvortex.com/v1.0.0/oauth/token)

Path parameters

id_organizationstring required

Organization identifier

Query parameters

offsetinteger

Number of records from which you will get publications (pagination)

limitinteger

The limit of records will be retrieved (pagination)

from_datestring date-time

Date from which records will be returned

to_datestring date-time

Date until which records will be returned

searchstring

String used to search results

orderByPublishboolean

Determine if the results will be ordered by publication_date instead of creation_date

social_networkSocialNetwork[]

Only publications of these networks. Repeat the parameter for more than one.

accountsstring[]

Retrieve publications based on a list of identifier accounts

statestring[]

Retrieve publications based on a list of states

Response

Successful operation

totalinteger required

Example response

{
  "publications": [
    {
      "files": [
        {
          "file_properties": {
            "aspect_ratio": {
              "value": 1.7777777777777777,
              "text": "16:9"
            }
          },
          "public_path": "https://a1b2c3d4e5f6.eu.r2.cloudflarestorage.com/planvortex-prod/orgs/60b.../60c.../foto.png?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Expires=86400&X-Amz-Signature=..."
        }
      ]
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.