Hootsuite Rest API Authentication API
Follow the steps below to make an authenticated API request.# 1. Request client credentials### Step 1: Create your OAuth 2.0 appFollow [these steps](https://developer.hootsuite.com/docs/getting-started-with-the-rest-api) to set up your app and retrieve your client credentials (`client_id` and `client_secret`):### Step 2: Retrieve the appId of your newly created app1. Go to your [Hootsuite Developer Apps](https://hootsuite.com/developers/my-apps) dashboard.2. Select `edit` for your newly created app.3. You can find the appId in the `appId` parameter of the browser URL. Ex: `https://hootsuite.com/developers/my-apps/app-directory/app/edit?appId=XXXXXX`### Step 3: Retrieve the organization ID of your Hootsuite organization1. Sign in into your [Hootsuite account](https://hootsuite.com).2. Select `My profile > Manage accounts and teams`.3. Select `Teams` for your organization.5. You can find the organization ID in the id query parameter in your browser's address bar.```https://hootsuite.com/dashboard#/organizations/teams/?id=```### Step 4: Request to link your organization to your app1. Add a member to your org that is not a paying member2. Make sure they have at least admin permission level3. Send an email to the Development Support Team to link your organization to your app: - To: `dev.support@hootsuite.com` - Include: - the `appId` you retrieved in *Step 2* - the `organization ID` you retrieved in *Step 3* - the `member ID` of the non-paying admin member4. Wait for the Development Support Team to link your app to your organization.# 2. Generate an access tokenWhen the developer app is correctly set up, you can use your `client_id` and `client_secret` to retrieve an `access_token` to make authorized API requests.When the `access_token` expires, use the [/oauth2/token](#operation/oauthToken) to generate a new token.This endpoint requires that you pass in your client credentials (`client_id` and `client_secret`) using the HTTP Basic authentication scheme as described in the [OAuth 2.0 specification](https://datatracker.ietf.org/doc/html/rfc6749#section-2.3.1).Including your client credentials in the request-body is not supported.When the `access_token` expires, the API returns a 401 unauthorized. The client can automate this by generating a new accesstoken and replaying the failed request with the fresh access token, as described in the following section.# 3. Include the access token as a bearer token Authorization headerAdd the bearer token in the Authorization header```textAuthorization: Bearer ```Example request with token```shell$ curl -X GET https://platform.hootsuite.com/inbox/v1/reporting/metrics/agent-availability \ -H 'Authorization: Bearer oZy8FDUHEiZ0mh0j4rUwOT9t5yHouTzBDsn-x_GROB0.rz-pMQzh-1F6VIGwnJZMBwH3SRwDfEHE4CRi-AClpcg'```
Hootsuite Rest API Authentication API is one of 21 APIs that Hootsuite publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include rest-api-authentication. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, a getting-started guide, authentication docs, and rate-limit docs.
This API exposes 1 operation across 1 path, and defines 2 schemas. It is described by OpenAPI 3.2.0, at version v1.
Requests are made against a single base URL, https://platform.hootsuite.com.
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 4
Hootsuite Rest API Authentication API declares
4 security schemes
for authenticating requests.
It accepts HTTP bearer tokens (bearer-token).
It accepts HTTP basic authentication (basic-auth).
It supports OAuth 2.0 (Oauth2ClientCredentials) using the clientCredentials flow, exposing 1 scope.
An API key is passed in the header as X-Hootsuite-Signature (SharedSecret).
By default, every request must be authenticated.
Paths & Operations 1
Across 1 path, the API surfaces 1 operation — 1 POST. Each is listed below with its method, path, parameters, and response codes.
Follow the steps below to make an authenticated API request. 1. Request client credentials Step 1: Create your OAuth 2.0 app Follow [these steps](https://developer.hootsuite.com/d…
Schemas 2
The contract defines 2 schemas that model the data the API accepts and returns. The most detailed are OAuthError (4 properties), OAuth2BearerToken (3 properties). Each schema is shown below with its type and property counts.
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Hootsuite 12
Other APIs Hootsuite publishes across the network.
This is an independent, third-party profile of Hootsuite Rest API Authentication API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.
The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.
Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.
info@apievangelist.com
·
Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and
you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.