Getting Started with Papershift API

Use the following short description to activate your Papershift API functions

1. Activate the Papershift API Addon

The Papershift API is an add-on subscription. To get started, contact our sales team or reach out to your customer success manager to activate it for your account.

2. Generate your API Key

With an active API subscription, you can now create your API key:

Log in to your Papershift account. Click the gear icon in the bottom-left corner and select Account Settings. Switch to the API tab. Click Create New API Key, which creates a new key with read and write permissions by default. Edit the permissions if needed, or copy the key to your clipboard.

3. Key Things to Know About the Papershift API

API Base URL

The production base API URL is:

https://app.papershift.com/public_api/v1/

Authentication

Every request must include an api_token to identify the client. This helps protect the API from misuse and enables client-specific features.

To generate your API key, sign in at Papershift and head to the API section in your account settings.

Interface Language

To return responses in the appropriate language, every request must include an interface_language parameter using a two-letter ISO 639-1 code (e.g., en, de).

Use the language your application displays to the user - which is not necessarily the user’s device or preferred language.

HTTP

Requests should include these headers:

• Content-Type: application/json
• Accept: application/json

Note: HTTP/1.1 doesn’t support sending meaningful data in the body of a GET request. Use URL parameters for those.

Request Structure Recommendation

To summarize, each request should include:

• api_token (in the request body or URL parameters)
• Any other parameters in the request body (for applicable HTTP methods)

External ID

This API uses external IDs to reference records. When API-Mode Forms are enabled, absences, users, and absence types will include a field for the external ID.

These IDs must be unique per model within the account and can only be created or updated by users with the Account Admin role.

Something missing?

Please share your feedback with us here via email: [email protected]