API docs by Redocly

Hootsuite Apps API (1.5.0)

Download OpenAPI specification:Download

Generic IDL for planned content apps in app directory

OAuth2

Endpoints that need to be implemented to support OAuth2

OAuth2 Authorization

OAuth2 Authorize endpoint. Please note that this authorization url is configured in the developer portal.

query Parameters
response_type
required
string
client_id
required
string
redirect_uri
required
string
state
required
string
scope
string

Responses

Oauth2 token endpoint

OAuth2 Token endpoint. Please note that this authorization url is configured in the developer portal. The required parameters depend on the grant type requested:

Authorization Code:

  • grant_type: authorization_code
  • client_id
  • client_secret
  • code
  • redirect_uri

Refresh Token

  • grant_type: refresh_token
  • client_id
  • client_secret
  • refresh_token
Request Body schema: application/json
grant_type
string
code
string
redirect_uri
string
client_id
string
client_secret
string
refresh_token
string

Responses

Request samples

Content type
application/json
{
  • "refresh_token": "refresh_token",
  • "code": "code",
  • "grant_type": "grant_type",
  • "redirect_uri": "redirect_uri",
  • "client_secret": "client_secret",
  • "client_id": "client_id"
}

Response samples

Content type
application/json
{
  • "access_token": "access_token",
  • "refresh_token": "refresh_token",
  • "token_type": "token_type",
  • "expires_in": "expires_in"
}

Media

Endpoints to perform actions on Media

Retrieve media

Retrieve media content and optionally filter by search criteria and mediaType. If no parameters are given, the app should return either the contents of the base folder if it has a folder hierarchy or trending/popular media results otherwise.

query Parameters
parentId
string

The ID of the parent folder that the user wants to get the children of.

cursor
string

A cursor returned by a previous call to this endpoint. Used to return the next page of results. All params from the previous request must be encoded in the cursor, so that a subsequent call can be made with only the cursor to fetch the next or previous page of results.

query
string

Search text entered by the user

pageSize
integer

Number of results to return per page

header Parameters
Authorization
string
Example: Bearer ahsi1jdi2kcnwjxlo10

Bearer token that allows Hootsuite to issue requests on a user's behalf. This is only present if the app was configured for oauth2 authentication. The token will have been previously returned from /oauth2/token.

Responses

Response samples

Content type
application/json
{
  • "data": [],
  • "metadata": {
    }
}

PlannedContent

Endpoints that need to implemented to support planned content

Retrieve planned content

This endpoint returns planned content items based on the provided parameters.

query Parameters
startDate
string <date>
endDate
string <date>
parentId
string
cursor
string
header Parameters
Authorization
required
string

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}

Status

Endpoints for status checks

Get status of server

Handles the status endpoint

Responses