How Base URLs Are Constructed
Base URL + Endpoint Path = Final Request URL
| Environment | Base URL | Example Endpoint | Final Request URL |
|---|---|---|---|
| Staging | https://external.staging.pleo.io | /v2/employees | https://external.staging.pleo.io/v2/employees |
| Production | https://external.pleo.io | /v2/employees | https://external.pleo.io/v2/employees |
Choosing an Environment
We offer Staging and Production environments.- Staging: safe testing, experiments, pre-production validation
- Production: live data, ready integrations
Authentication
Pleo APIs support multiple authentication methods depending on the integration type.| Method | Typical Use |
|---|---|
| OAuth 2.0 | Partner integrations |
| Integrated API Keys | Approved exception only |
| Standalone API Keys | Restricted integrations and specific use cases |
OAuth 2.0 (Bearer Token)
Partner integrations must use OAuth 2.0. API requests must include the following header:Integrated API Keys
Upon approval from Pleo, some partner integrations may be permitted to use Integrated API Keys.Standalone API Keys
Standalone API Keys have restricted availability and are only supported by Pleo’s NEW External APIs. If enabled for your account, follow the Standalone API Key Workflow Guide to create a key and make your first API request. Authentication uses Basic HTTP authentication:- API key as the username
- Empty password
- Credentials are automatically Base64 encoded
What Comes Next?
Review Integration Requirements
- Integration Design for OAuth 2.0 Overview
- Integration Design for Standalone API Keys
Setup Authentication
- OAuth 2.0 Access to Staging Workflow Guide
- OAuth 2.0 Setup Workflow Guide (Manual Token Lifecycle)
- OAuth 2.0 Setup with Postman
- Standalone API Key Workflow Guide
FAQs
What is the difference between legacy APIs and new APIs?
What is the difference between legacy APIs and new APIs?
Legacy APIs (OpenAPI)
- Base URL:
https://openapi.pleo.io - Authentication: API tokens (legacy tokens)
- Availability: Intended for existing/legacy use cases. Access can depend on your account setup and entitlements.
- Lifecycle: Deprecated. Pleo is working on a deprecation timeline and migration plan.
- Base URL:
https://external.pleo.io - Authentication: API keys (and other authentication methods supported by the platform, including OAuth 2.0, depending on the use case)
- Availability: Restricted access. Documentation may be publicly visible, but access is not broadly enabled by default. Standalone API keys require explicit enablement.
- What to expect: Newer platform surface and improved structure, but not guaranteed feature parity with legacy APIs yet.
- Legacy API tokens will not work on
external.pleo.io - New API keys will not work on
openapi.pleo.io