Skip to main content

Rise Developer Portal

The Rise Public API lets you read and write data across Rise People — employees, payroll, reporting, and webhooks — from your own applications. Use it to connect Rise to your accounting system, benefits platform, employee-rewards tool, or internal tooling.

Who this is for​

  • Customers building custom integrations with their Rise account
  • Partners (accounting, benefits platforms, employee-rewards providers) offering a Rise connector to mutual customers
  • Rise internal teams building on top of the same public surface their customers use

Every endpoint documented here is the same one our own Rise web and mobile apps call. If it's in here, it's supported and versioned.

Getting started​

A three-step loop:

  1. Register an OAuth application in your Rise account settings.
  2. Obtain an access token using Client Credentials (server-to-server) or Authorization Code + PKCE (acting on behalf of a user).
  3. Make your first API call — fetch an employee, list a payroll run, or subscribe to a webhook.

The full walk-through is in the Quickstart. Reference docs for every endpoint live under API Reference in the sidebar.

API conventions at a glance​

  • Base URL: https://api.risepeople.com/v1
  • Content type: application/json for requests, application/json or application/problem+json for responses
  • Authentication: Authorization: Bearer <access_token> on every request
  • Idempotency: mutating endpoints accept an Idempotency-Key header (UUID)
  • Pagination: JSONAPI page-based — use page[number] and page[size] query parameters; response carries meta (record count) and links (first / next / last). The meta key is record_count for some services and count for others — read whichever the endpoint's reference shows.
  • Errors: three formats depending on the kind of error — RFC 7807 problem details for cross-cutting failures (rate-limit, scope, token), { errors: [...], request_id } for resource and validation failures, and RFC 6749 for OAuth-token endpoints. See Errors.
  • Request tracing: every response includes an X-Request-Id header — quote it in support requests

Services​

Use the sidebar under API Reference to browse the per-service reference. Each service has its own spec and scope set.

Versioning​

All public endpoints live under /v1. We commit to this contract: no breaking changes within a major version. When we need to break, we introduce /v2 and run both concurrently for at least 12 months. Deprecations are announced on the changelog with a Deprecation header on affected responses.

Rate limits​

See Rate limits for the current tiers and backoff guidance.

Support​