Getting Started

Introduction

The Mployr System API provides programmatic access to HR, payroll, and workforce management functionality. This RESTful API uses JSON for request and response bodies, and JWT Bearer tokens for authentication.

Making Your First Request

To get started, you'll need to authenticate and obtain an access token. Here's how to make your first API request:

# Login to get an access token
curl -X POST https://api.mployr.com.au/v1/login \
  -H "Content-Type: application/json" \
  -d '{
    "email": "your@email.com",
    "password": "your-password"
  }'

# Response
{
  "success": true,
  "data": {
    "token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9...",
    "token_type": "Bearer",
    "expires_in": 86400
  }
}

Response Format

All API responses follow a consistent JSON structure with a success field and a data field containing the response payload.

Single Resource

{
  "success": true,
  "data": {
    "id": 1,
    "first_name": "John",
    "last_name": "Doe",
    "email": "john.doe@example.com",
    "created_at": "2024-01-15T10:30:00Z"
  }
}

Paginated List

List endpoints return paginated results with metadata about the current page, total items, and navigation.

{
  "success": true,
  "data": [
    { "id": 1, "first_name": "John", "last_name": "Doe" },
    { "id": 2, "first_name": "Jane", "last_name": "Smith" }
  ],
  "pagination": {
    "current_page": 1,
    "per_page": 15,
    "total": 100,
    "last_page": 7,
    "from": 1,
    "to": 15
  }
}

Next Steps