Welcome to the Firstup API developer portal.
Here you’ll find comprehensive documentation on our API, including the API reference, conceptual articles to help you understand how the API works and how to integrate with it effectively, and use case examples to inspire your implementation.
Currently, authorization bearer tokens need to be issued by Firstup. Contact Firstup to obtain your ClientID and ClientSecret to get your token. Once you have your token, you can start making API calls:
- Try it - Use this portal to make some
GETrequests. Simply enter your token and start selectingGET. Go to our Try it article to get started. - Postman - From the API Landing page, download the openapi.json or openapi.yaml file and import it into Postman. Further guidance can be found here.
Ease your way into our API by exploring our conceptual documentation. This explains exactly what our endpoints do and what they can offer you.
From a business standpoint, learn what our APIs can do to help you achieve your goals. From a technical perspective, understand the conceptual workings and expected behavior of our API.
Browse our API reference for a complete list of endpoints, schemas, and example requests and responses.
Before diving into the API reference and endpoints, learn how our API works overall—how to connect, authenticate, and integrate it into your systems.
This article covers security and scalability, resource representation, request handling (authentication, HTTP verbs, pagination, sorting, filtering, etc.), and responses—both successful and error cases.
These articles provide an overview of OAuth, how to obtain an access token for requests, and general authorization methods.
The Firstup API uses SCIM for cross-domain identity management. These sections explain SCIM and how to use it with our User Management APIs.
Learn about our webhooks functionality, including how to create a subscription, event lists, user notifications, deliveries, and subscription testing. A dedicated section also covers common use cases.
Review our terms of service and our privacy policy articles.