Step 1: Get Your API Token

Contact your Worky administrator to obtain your API credentials. Once you have them, you're ready to make API calls.

Step 2: Make Your First Request

Let's fetch a list of employees from your organization:

cURL
curl -X GET "https://api-nova-dev.worky.mx/accounts/directory/api/v1/employees" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json"
JavaScript (fetch)
const response = await fetch(
  'https://api-nova-dev.worky.mx/accounts/directory/api/v1/employees',
  {
    method: 'GET',
    headers: {
      'Authorization': 'Bearer YOUR_API_TOKEN',
      'Content-Type': 'application/json'
    }
  }
);

const employees = await response.json();
console.log(employees);
Python (requests)
import requests

response = requests.get(
    'https://api-nova-dev.worky.mx/accounts/directory/api/v1/employees',
    headers={
        'Authorization': 'Bearer YOUR_API_TOKEN',
        'Content-Type': 'application/json'
    }
)

employees = response.json()
print(employees)

Step 3: Handle the Response

A successful response will return a paginated list of employees:

Response (200 OK)
{
  "content": [
    {
      "id": "emp-123-abc",
      "firstName": "Juan",
      "lastName": "PΓ©rez",
      "email": "[email protected]",
      "status": "ACTIVE",
      "hireDate": "2024-01-15",
      "department": "Engineering"
    },
    {
      "id": "emp-456-def",
      "firstName": "MarΓ­a",
      "lastName": "GarcΓ­a",
      "email": "[email protected]",
      "status": "ACTIVE",
      "hireDate": "2023-06-01",
      "department": "Human Resources"
    }
  ],
  "page": 0,
  "size": 20,
  "totalElements": 150,
  "totalPages": 8
}

Next Steps

πŸ“š Explore User Flows

Learn how to implement complete HR workflows like hiring, payroll, and attendance.

πŸ” API Reference

Dive into the complete API documentation for all available endpoints.