Aboard API (1.0.1)

Base URL

• Production: https://api.aboardhr.com/v1/

Authentication

The Aboard API uses Bearer token authentication. All API requests must include a valid authentication token in the Authorization header.

Getting an API token

1. Contact your system administrator to obtain an API token
2. Token format: The token should be a JWT (JSON Web Token) string
3. Token scope: Tokens are scoped to specific companies and may have role-based permissions

Setting up authentication

Using cURL:

# Set your token as an environment variable
export ABOARD_API_TOKEN="your_token_here"

# Use the token in requests
curl -H "Authorization: Bearer $ABOARD_API_TOKEN" \
     https://api.aboardhr.com/v1/company

Using JavaScript/Fetch:

const token = 'your_token_here';
const response = await fetch('https://api.aboardhr.com/v1/company', {
  headers: {
    'Authorization': `Bearer ${token}`,
    'Content-Type': 'application/json'
  }
});

Authentication errors

If your token is invalid or missing, you'll receive a 401 Unauthorized response with an empty body:

HTTP/1.1 401 Unauthorized
Content-Length: 0

Token security

• Keep your token secure and never commit it to version control
• Use environment variables to store tokens in your applications
• Rotate tokens regularly as recommended by your security policy
• Report compromised tokens immediately to your system administrator

1. Get company information

curl -H "Authorization: Bearer YOUR_TOKEN" \
     https://api.aboardhr.com/v1/company

2. List employees

curl -H "Authorization: Bearer YOUR_TOKEN" \
     https://api.aboardhr.com/v1/employees

3. Filter employees by role

curl -H "Authorization: Bearer YOUR_TOKEN" \
     "https://api.aboardhr.com/v1/employees?filter[role]=manager"

4. Get time-off requests

curl -H "Authorization: Bearer YOUR_TOKEN" \
     https://api.aboardhr.com/v1/time-off-requests

5. List time tracking projects

curl -H "Authorization: Bearer YOUR_TOKEN" \
     https://api.aboardhr.com/v1/time-tracking-projects

Pagination

All list endpoints support pagination using page[limit] and page[offset] parameters:

# Get first 10 employees
curl -H "Authorization: Bearer YOUR_TOKEN" \
     "https://api.aboardhr.com/v1/employees?page[limit]=10&page[offset]=0"

Filtering

Many endpoints support filtering:

• Employees: Filter by role (employee, manager, superadmin)
• Time-off Requests: Filter by status, time_off_policy_id, time_off_policy_type_id, date, from_date, to_date, requested_at, requested_at_from, requested_at_to
• Time Tracking Entries: Filter by status, time_tracking_project_id, date, from_date, to_date, from_time, to_time

Response format

All responses follow the JSON:API specification with:

• data: The main resource(s)
• links: Pagination links
• relationships: Links to related resources

Example response:

{
  "data": [
    {
      "id": "1",
      "type": "employees",
      "links": {
        "self": "https://api.aboardhr.com/v1/employees/1"
      },
      "attributes": {
        "first-name": "Andy",
        "last-name": "Bernard",
        "work-email": "andy-bernard@company.com",
        "role": "manager"
      },
      "relationships": {
        "time-off-requests": {
          "links": {
            "self": "https://api.aboardhr.com/v1/employees/1/relationships/time-off-requests",
            "related": "https://api.aboardhr.com/v1/employees/1/time-off-requests"
          }
        }
      }
    }
  ],
  "links": {
    "first": "https://api.aboardhr.com/v1/employees?page[limit]=20&page[offset]=0",
    "last": "https://api.aboardhr.com/v1/employees?page[limit]=20&page[offset]=0"
  }
}

Company

• GET /v1/company - Get company information

Employees

• GET /v1/employees - List all employees
• GET /v1/employees/{id} - Get specific employee

Bank details

• GET /v1/bank-details - List all bank details
• GET /v1/bank-details/{id} - Get specific bank details

Supported Bank Detail Types:

• US: Routing number (9 digits)
• IBAN: BIC/SWIFT code for international accounts
• UK: Sort code (6 digits in XX-XX-XX format)
• Canada: Institution number (3 digits) + Branch transit number (5 digits)
• Australia: BSB code (6 digits in XXX-XXX format)
• Denmark: Registration number (4 digits)
• Norway: Bank code (4 digits)
• Sweden: Clearing number (4 digits)
• South Africa: Branch code (6 digits)
• Singapore: Bank code (4 digits) + Branch code (3 digits)
• New Zealand: BBAN (Basic Bank Account Number)
• Colombia: Bank code (4 digits) + Branch code (4 digits)
• SWIFT: International SWIFT code format

Time tracking

• GET /v1/time-tracking-projects - List time tracking projects
• GET /v1/time-tracking-projects/{id} - Get specific project
• GET /v1/time-tracking-entries - List time tracking entries
• GET /v1/time-tracking-entries/{id} - Get specific entry

Time-off management

• GET /v1/time-off-requests - List time-off requests
• GET /v1/time-off-requests/{id} - Get specific request
• GET /v1/time-off-policies - List time-off policies
• GET /v1/time-off-policies/{id} - Get specific policy
• GET /v1/time-off-policy-types - List policy types
• GET /v1/time-off-policy-types/{id} - Get specific policy type

Organization

• GET /v1/departments - List departments
• GET /v1/departments/{id} - Get specific department
• GET /v1/job-titles - List job titles
• GET /v1/job-titles/{id} - Get specific job title
• GET /v1/locations - List locations
• GET /v1/locations/{id} - Get specific location

Profile attributes

• GET /v1/profile-attributes - List custom profile attributes
• GET /v1/profile-attributes/{id} - Get specific profile attribute
• GET /v1/profile-attribute-options - List profile attribute options
• GET /v1/profile-attribute-options/{id} - Get specific option
• GET /v1/profile-attribute-values - List profile attribute values
• GET /v1/profile-attribute-values/{id} - Get specific value

The API uses standard HTTP status codes:

• 200 - Success
• 401 - Unauthorized (invalid or missing token) - Returns empty response body
• 404 - Resource not found
• 422 - Validation error

Authentication errors return empty response body:

HTTP/1.1 401 Unauthorized
Content-Length: 0

Company information and settings

Employee records and core profile information

Detailed employee data including employments, addresses, positions, and salaries

Employee bank account and payment information

Company departments and organizational units

Job titles and roles within the organization

Office locations and work sites

Custom profile attributes, options, and values for employees

Time tracking projects and entries