Firstup API

Welcome to the Firstup API developer portal. This portal includes all documentation relating to our API, including API reference, that gives you all the developer information needed for our endpoints, conceptual articles to help you understand how our API works, and how to properly utilize and integrate with it, and use case examples to help inspire you.

API Concept

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.

API Reference

Browse our API reference that lists all our endpoints, schemas and example request or responses.

API Documentation

Before exploring our API reference and available endpoints, get to grips with how our overall API works, how to connect and how to integrate:

API Basics

This article covers security and scalability, resource representation, how we handle requests (authentication, verbs, pagination, sorting, filtering, etc.), and responses (both successful and errors).

Authentication and Authorization

These articles cover an overview of OAuth, gaining an access token for our requests and general authorization methods.

SCIM

Firstup API uses SCIM for cross-domain identity management. These sections cover an overview of SCIM and how to apply this when utilizing our User Management APIs.

Webhooks

These sections cover an overview of our webhooks functionality, including creating a subscription, event lists, user notifications, deliveries and testing subscriptions. There is also a section for use cases.

Terms of Service and Privacy Policy

Review our terms of service and our privacy policy articles.