Getting started with Teamfluence API

Teamfluence now provides an API to manage your teamspace resources.

Base URL

Use the following base URL for all API requests:

https://api.teamfluence.app/external

E.g. to fetch all team members feed posts in the workspace:

https://api.teamfluence.app/external/{profile_id}/posts

Authorization

To access the API, you need an API key. Only users with the Administrator or Teamspace Owner role can generate an API key.

You can find your API key at the bottom of your Profile page.

Note: Teamfluence uses rotating secret keys. If you need to deactivate an existing API key and generate a new one, please submit a support ticket.

profile_id always present as a URL path parameter to identify the user making the API request and doesn’t limit the scope of teamspace resources being returned.

If profile_id and API key belong to a user, whose profile was removed or deactivated in the teamspace, API requests will fail.

Authentication

Include your API key in the Authorization header of each request:

Authorization: Bearer

Here Authorization is HTTP header key and Bearer goes to HTTP header value.

Possible Error Codes

The API may return the following error codes:

• 202 Accepted - The API request was accepted but wasn’t completed (see response body detail field for more details. e.g. billing limitation).

• 400 Bad Request – The request was malformed or missing required parameters.

• 401 Unauthorized – The API key provided was invalid or missing.

• 402 Missing Billing Scope – Your teamspace subscription does not include API access.

• 404 Not Found – The requested resource was not found.

• 429 Too Many Requests - Your personal access key hit API rate limit per second.

• 500 Internal Server Error – An unexpected error occurred on the server.