The Aspire API lets you programmatically access your Aspire data — including posts, projects, groups, and members — so you can build custom reports, integrate with your own tools, or pipe data into downstream workflows.
This guide walks you through creating your first API key and making a test request.
Before You Start
You'll need:
An Aspire account with permissions to manage integrations
A way to test HTTP requests (the built-in API documentation works, or you can use Postman, curl, etc.)
Step 1: Create an API Key
From your Aspire homepage, click the Settings button in the top-left corner.
In the left navigation, scroll to the Integrations section and select Aspire API.
Click Create API Key.
Fill in the key details:
Name — a label to help you identify this key later (e.g., "Reporting Pipeline" or "Marketing Dashboard").
Permissions — select the scopes this key should have access to. Grant only what you need.
Expiration — choose how long the key should stay valid. Options are:
30 days
60 days
90 days
1 year
No expiration
Click Create API Key.
❗Important: Copy your key now
Once the key is generated, copy the key value and store it somewhere secure — a password manager, a secrets vault, or your team's secure credential store.
After you click Done, the key value is hidden and cannot be retrieved again. If you lose it, you'll need to generate a new key.
Step 2: Find Your Client ID
Every API request needs a Client ID, which identifies your Aspire workspace.
To find it:
Go back to your Aspire workspace in your browser.
Look at the URL in the address bar. The Client ID appears in the path, directly after
/client/.Copy that value — you'll use it as the client_id parameter in your API requests.
Step 3: Test Your First Request
Aspire includes built-in API documentation so you can test requests directly in the browser.
From the Aspire API settings page, open the API Documentation link.
Locate the endpoint you want to try. For example, List Posts returns all posts in your workspace.
Click Test Request.
Fill in the required fields:
Token — paste the API key you copied in Step 1.
Client ID — paste the Client ID from Step 2.
Date range — set the start and end dates for the posts you want to return (for example, 2026-03-01 to 2026-03-31).
Leave the optional filters blank for now (see below for what they do).
Click Send.
The response appears as a JSON payload containing every post that matches your filters.
Optional Filters
The List Posts endpoint supports several optional filters to narrow your results:
Project ID — return posts only from a specific project. Find the ID in the URL when you open a project — it appears after
/project/.
Group ID — return posts only from a specific group. This appears after
groupIds.is=
Member ID — return posts only from a specific member. This appears after
/member/
To use a filter, copy the relevant ID from the URL of that project, group, or member page in Aspire, and paste it into the matching field in the request.
If you leave all three blank, the API returns posts across every project, group, and member in your workspace.
Example Request
Here's a typical request to pull all posts from Q1 2026 across every project:
Field | Value |
Token | your_api_key_here |
Client ID | your_client_id |
Start date | 2026-01-01 |
End date | 2026-03-31 |
Project ID | (leave blank) |
Group ID | (leave blank) |
Member ID | (leave blank) |
The response returns a JSON array of posts matching those dates.
Best Practices
Store keys securely. Never commit API keys to source control or share them in plain text.
Use least privilege. Grant each key only the permissions it needs.
Set an expiration. Rotating keys on a regular cadence limits the blast radius if one is ever compromised.
Use separate keys per integration. If a key needs to be revoked, you won't break every integration at once.
Troubleshooting
I lost my API key — can I recover it? No. For security reasons, the key value is only shown once. Generate a new key and update any integrations that used the old one.
My request returns a 401 Unauthorized error. Double-check that your token is pasted correctly (no extra spaces) and that the key hasn't expired. Confirm the permissions attached to the key cover the endpoint you're calling.
My request returns an empty array. Verify your Client ID is correct and that the date range actually contains posts. Try widening the date range or removing optional filters.
Need Help?
If you run into issues or have questions about the API, reach out to the Aspire team and we'll get you unblocked.