The Aspire API gives you programmatic access to your Aspire data—including posts, projects, groups, and members—so you can build custom reports, integrate with internal tools, or automate downstream workflows.
This guide walks you through creating your first API key and making your first API request.
Before You Begin
You'll need:
An Aspire account with permissions to manage integrations.
A tool for making HTTP requests. You can use the built-in API documentation, Postman,
curl, or any API client of your choice.
Step 1: Create an API Key
From your Aspire homepage, click Settings in the bottom left corner.
Click Integrations and select Aspire API.
Click Create API Key.
Complete the following fields:
Name: Choose a descriptive name to help identify the 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 remain active:
30 days
60 days
90 days
1 year
No expiration
Click Create API Key.
Copy your API key immediately.
❗Important: For security reasons, the key value is displayed only once. Store it in a secure location, such as a password manager, secrets vault, or your organization's credential manager.
After you click Done, the key cannot be viewed again. If it's lost, you'll need to generate a new one.
Step 2: Find Your Client ID
Every API request requires your Client ID, which identifies your Aspire workspace.
To locate it:
Open 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 the value that appears immediately after
/client/. You'll use this value as theclient_idparameter in your API requests.
Step 3: Make Your First Request
Aspire includes interactive API documentation that lets you test endpoints directly from your browser.
From the Aspire API settings page, open the API Documentation link or click here.
Select an endpoint to test. For example, List Posts returns all posts in your workspace.
Click Test Request.
Provide the required fields:
Token: Paste the API key you copied in Step 1.
Client ID: Paste your 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.
If the request is successful, the API returns a JSON response containing every post that matches your criteria.
Optional Filters
The List Posts endpoint supports several optional filters to narrow your results:
Project ID — return posts from a specific project.
To find the Project ID, open the project in Aspire and copy the value that appears after/project/in the URL.
Group ID — return posts from a specific group.
Open the group in Aspire and copy the value that appears aftergroupIds.is=in the URL.
Member ID — return posts from a specific member.
Open the member profile and copy the value that appears after/member/or/contact/in the URL.
If you leave all three filters blank, the API returns posts across all projects, groups, and members 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 is a JSON array containing all posts that match the specified date range.
Best Practices
Store API keys securely. Never commit keys to source control or share them in plain text.
Use least privilege. Grant each API key only the permissions required for its integration.
Rotate keys regularly. Setting an expiration and periodically creating new keys reduces security risk.
Create separate keys for each integration. If one key needs to be revoked, other integrations remain unaffected.
Troubleshooting
I lost my API key. Can I recover it?
No. For security reasons, API keys are only displayed once when they're created. If you lose a key, generate a new one and update any integrations using the old key.
My request returns a 401 Unauthorized error.
Check the following:
The API key is copied correctly with no extra spaces.
The key hasn't expired.
The key has permission to access the endpoint you're calling.
My request returns an empty array.
Verify that:
Your Client ID is correct.
The selected date range contains matching data.
Any optional filters are correct.
If needed, remove the filters or expand the date range to confirm data is available.
Need Help?
If you have questions or run into issues while working with the Aspire API, contact the Aspire support team. We're happy to help you get up and running.