Five steps from a blank page to a working request.
To obtain your API key, please contact the AgencyPlatform Support team.
Click the Authorize button in the top right. Your key is verified with the API, then saved in your browser's local storage for live testing.
Select an endpoint from the sidebar navigation (e.g., Projects or API Usage).
Click the Try it out button in the code panel to send a live test request directly to the API.
Choose your preferred programming language and copy the auto-generated code snippet into your application.
All API requests must include your API key in the header. When testing in this portal, your credentials are saved locally in your browser and are never exposed.
Authenticate your requests by passing your API key in the header. Requests are securely validated to ensure that the API key is valid and authorized to access the requested resources.
Authorize verifies your key against the API before saving it. For convenience during testing, a valid key is stored locally in your browser (via localStorage) and remains available across tabs until cleared. The full key is never visible after it has been saved.
AgencyPlatform-only keys are not enough. Contact the AgencyPlatform Support team to activate your API key and define its daily request quota, per-minute rate limits, and lifetime limits.
The Agency Connect API uses standard HTTP response codes to indicate the success or failure of API requests. When an error occurs, the response body contains a JSON object with a descriptive message explaining the failure. Use the HTTP status code to determine the appropriate resolution.
What it means:
How to fix:
What you can pass to this endpoint. Try a live request from the Code panel.
No parameters required.
Default:
What’s in a successful data payload.
No schema properties documented.
HTTP status codes you might see from this endpoint.
Enter your . Authorize verifies the key with the API before saving it in localStorage for this browser (across tabs) until you Clear it. The full key is never shown after it has been saved.