Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.perscom.io/llms.txt

Use this file to discover all available pages before exploring further.

The PERSCOM API provides programmatic access to your personnel data, enabling integration with third-party services and custom applications.

​
Getting Started

Jumpstart your integration using our official Postman collection. Run in Postman

OpenAPI Specification

View the PERSCOM API OpenAPI specification file.

​
Base URL

All API requests use the following base URL: 
https://api.perscom.io/{version}
Replace {version} with the API version. The current version is v2.

​
Request Format

The PERSCOM API uses a RESTful interface. Requests require:
  • An HTTP method: GET, POST, PUT, PATCH, or DELETE
  • An API key passed as a Bearer token in the Authorization header
  • The Accept: application/json header

​
Authentication

API requests require authentication via an API key. Pass your key as a Bearer token in the Authorization header: 
Authorization: Bearer YOUR_API_KEY
Manage your API keys in the PERSCOM dashboard under Integrations > API Keys. For more details, see Authentication.

​
Caching

The PERSCOM API uses a worldwide CDN to deliver fast responses. When you update data through the dashboard, the cache refreshes automatically. If you encounter stale data, you can purge the cache from the Integrations > API Keys section in your dashboard.

​
Examples

use GuzzleHttp\Client;

$client = new Client();

$headers = [
    'Accept' => 'application/json',
    'Authorization' => "Bearer {$apiKey}"
];

$response = $client->request('GET', 'https://api.perscom.io/v2/users', [
    'headers' => $headers
]);

echo 'Status code: ' . $response->getStatusCode();