# Hootsuite Rest API Authentication API **Canonical:** https://apis.io/apis/hootsuite/hootsuite-rest-api-authentication-api/ **Provider:** Hootsuite — https://apis.io/providers/hootsuite/ **Base URL:** https://platform.hootsuite.com/v1 **Documentation:** https://developer.hootsuite.com/docs/api-overview Hootsuite Rest API Authentication API is one of 21 APIs that [Hootsuite](https://apis.io/providers/hootsuite/) publishes on the [APIs.io](https://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. 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/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 app 1. 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 organization 1. 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 app 1. Add a member to your org that is not a paying member 2. Make sure they have at least admin permission level 3. 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 member 4. Wait for the Development Support Team to link your app to your organization. # 2. Generate an access token When 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 access token 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 header Add the bearer token in the Authorization header ```text Authorization: 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' ``` ## Operations (1) | Method | Path | Summary | |---|---|---| | POST | `/oauth2/token` | OAuth2 Token | ## Machine-readable artifacts (19) - **OpenAPI** — https://raw.githubusercontent.com/api-evangelist/hootsuite/refs/heads/main/openapi/hootsuite-rest-api-authentication-api-openapi.yml - **Documentation** — https://developer.hootsuite.com/docs/api-overview - **APIReference** — https://apidocs.hootsuite.com/docs/api/index.html - **GettingStarted** — https://developer.hootsuite.com/docs/getting-started-with-the-rest-api - **Authentication** — https://developer.hootsuite.com/docs/api-authentication - **OAuth 2.0** — https://developer.hootsuite.com/docs/enabling-oauth-20 - **Postman** — https://app.getpostman.com/run-collection/eeda0fcdf55ea26bd0ec - **Webhooks** — https://raw.githubusercontent.com/api-evangelist/hootsuite/refs/heads/main/asyncapi/hootsuite-webhooks.yml - **RateLimits** — https://raw.githubusercontent.com/api-evangelist/hootsuite/refs/heads/main/rate-limits/hootsuite-rate-limits.yml - **ErrorCatalog** — https://raw.githubusercontent.com/api-evangelist/hootsuite/refs/heads/main/errors/hootsuite-problem-types.yml - **DataModel** — https://raw.githubusercontent.com/api-evangelist/hootsuite/refs/heads/main/data-model/hootsuite-data-model.yml - **Documentation** — https://developer.hootsuite.com/docs/analytics-overview - **APIReference** — https://apidocs.hootsuite.com/docs/api/analytics/index.html - **GettingStarted** — https://developer.hootsuite.com/docs/using-the-api - **OAuthScopes** — https://raw.githubusercontent.com/api-evangelist/hootsuite/refs/heads/main/scopes/hootsuite-scopes.yml - **Documentation** — https://developer.hootsuite.com/docs/inbox-overview - **APIReference** — https://apidocs.hootsuite.com/docs/api/inbox/index.html - **Documentation** — https://developer.hootsuite.com/docs/amplify-overview - **APIReference** — https://amplify.hootsuite.com/api-docs ## Other Hootsuite APIs (12) - [Hootsuite Developer Documentation MCP](https://apis.io/apis/hootsuite/mcp/) - [Hootsuite Analytics API](https://apis.io/apis/hootsuite/hootsuite-analytics-api-api/) - [Hootsuite Authentication API](https://apis.io/apis/hootsuite/hootsuite-authentication-api/) - [Hootsuite Comments API](https://apis.io/apis/hootsuite/hootsuite-comments-api/) - [Hootsuite CRM Rest API](https://apis.io/apis/hootsuite/hootsuite-crm-rest-api-api/) - [Hootsuite CRM Webhooks API](https://apis.io/apis/hootsuite/hootsuite-crm-webhooks-api/) - [Hootsuite Me API](https://apis.io/apis/hootsuite/hootsuite-me-api/) - [Hootsuite Media API](https://apis.io/apis/hootsuite/hootsuite-media-api/) - [Hootsuite Members API](https://apis.io/apis/hootsuite/hootsuite-members-api/) - [Hootsuite Messages API](https://apis.io/apis/hootsuite/hootsuite-messages-api/) - [Hootsuite Organizations API](https://apis.io/apis/hootsuite/hootsuite-organizations-api/) - [Hootsuite Proactive Messaging Rest API](https://apis.io/apis/hootsuite/hootsuite-proactive-messaging-rest-api-api/) ## Tags rest-api-authentication --- Profiled by [API Evangelist](https://apievangelist.com) and published on [APIs.io](https://apis.io/apis/hootsuite/hootsuite-rest-api-authentication-api/). The API's provider profile, Kin Score and agent-readiness rating are at https://apis.io/providers/hootsuite/.