Getting Started

Connect to the Paismo Nexus API to access your organization's workforce data securely.

1. Authentication

The Nexus API uses custom headers for authentication to ensure strict employer scoping. You must include these two headers in every request:

• X-API-Key: Public identifier for your API client.
• X-API-Secret: Private secret key (treat this like a password).

X-API-Key: pk_live_123456...
X-API-Secret: sk_live_abcdef...

2. Base URL

All API requests should be made to the following base URL:

https://api.nexus.paismo.com

3. Your First Request

Let's fetch a list of employees to verify your connection.

cURL Example

curl -X GET "https://api.nexus.paismo.com/v1/employees?page_size=5" \
  -H "X-API-Key: YOUR_KEY" \
  -H "X-API-Secret: YOUR_SECRET"

Node.js (Axios) Example

const axios = require('axios');

const client = axios.create({
  baseURL: 'https://api.nexus.paismo.com',
  headers: {
    'X-API-Key': process.env.PAISMO_API_KEY,
    'X-API-Secret': process.env.PAISMO_API_SECRET
  }
});

async function getEmployees() {
  try {
    const { data } = await client.get('/v1/employees?page_size=5');
    console.log(data.items);
  } catch (error) {
    console.error('Error fetching employees:', error.response.data);
  }
}

getEmployees();

4. Pagination

Most list endpoints are paginated. The response includes a total count and the current page.

{
  "request_id": "...",
  "page": 1,
  "page_size": 10,
  "total": 145,
  "items": [ ... ]
}

To navigate, simply increment the page query parameter.