Introduction

REST API for Okta HR — mobile self-service, HR operations and Okta Suite internal integration.

Base URL: https://hr.getokta.io

Welcome to the **Okta HR API**. Use it to power the employee mobile app, integrate accounting/ERP systems, or connect other Okta Suite products.

All endpoints are versioned under \`/api/v1\` and return **JSON:API** documents. Mobile self-service endpoints live under \`/api/v1/me/*\`, and suite service-to-service endpoints under \`/api/internal/*\` (authenticated with the \`X-Service-Key\` header, not user tokens).

As you scroll, code examples appear on the right (or inline on mobile). Switch languages with the tabs at the top.

Authenticating requests

To authenticate requests, include an Authorization header with the value "Bearer {YOUR_TOKEN}".

All authenticated endpoints are marked with a requires authentication badge in the documentation below.

Obtain a Sanctum bearer token via POST /api/v1/auth/login (email, password, device_name), then send it as Authorization: Bearer {token}. The login endpoint itself and /api/internal/* (which uses the X-Service-Key header) do not use bearer tokens.

Endpoints

Example request:

curl --request POST \
    "https://hr.getokta.io/api/v1/auth/login" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"email\": \"gbailey@example.net\",
    \"password\": \"|]|{+-\",
    \"device_name\": \"v\"
}"

const url = new URL(
    "https://hr.getokta.io/api/v1/auth/login"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "email": "gbailey@example.net",
    "password": "|]|{+-",
    "device_name": "v"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Request

POST api/v1/auth/login

Headers

Content-Type

Example: application/json

Accept

Example: application/json

Body Parameters

email string

Must be a valid email address. Example: gbailey@example.net

password string

Example: |]|{+-

device_name string

Must not be greater than 100 characters. Example: v

Revoke the token used for the current request.

requires authentication

Example request:

curl --request POST \
    "https://hr.getokta.io/api/v1/auth/logout" \
    --header "Authorization: Bearer {YOUR_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "https://hr.getokta.io/api/v1/auth/logout"
);

const headers = {
    "Authorization": "Bearer {YOUR_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};


fetch(url, {
    method: "POST",
    headers,
}).then(response => response.json());

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

The authenticated user's profile (mobile self-service).

requires authentication

Example request:

curl --request GET \
    --get "https://hr.getokta.io/api/v1/me" \
    --header "Authorization: Bearer {YOUR_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "https://hr.getokta.io/api/v1/me"
);

const headers = {
    "Authorization": "Bearer {YOUR_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};


fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

List employees (paginated, filterable by status and search).

requires authentication

Example request:

curl --request GET \
    --get "https://hr.getokta.io/api/v1/employees" \
    --header "Authorization: Bearer {YOUR_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "https://hr.getokta.io/api/v1/employees"
);

const headers = {
    "Authorization": "Bearer {YOUR_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};


fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Show a single employee.

requires authentication

Example request:

curl --request GET \
    --get "https://hr.getokta.io/api/v1/employees/1" \
    --header "Authorization: Bearer {YOUR_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "https://hr.getokta.io/api/v1/employees/1"
);

const headers = {
    "Authorization": "Bearer {YOUR_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};


fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Request

GET api/v1/employees/{id}

Headers

Authorization

Example: Bearer {YOUR_TOKEN}

Content-Type

Example: application/json

Accept

Example: application/json

URL Parameters

id integer

The ID of the employee. Example: 1

List all departments of the current company.

requires authentication

Example request:

curl --request GET \
    --get "https://hr.getokta.io/api/v1/departments" \
    --header "Authorization: Bearer {YOUR_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "https://hr.getokta.io/api/v1/departments"
);

const headers = {
    "Authorization": "Bearer {YOUR_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};


fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

List all branches of the current company.

requires authentication

Example request:

curl --request GET \
    --get "https://hr.getokta.io/api/v1/branches" \
    --header "Authorization: Bearer {YOUR_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "https://hr.getokta.io/api/v1/branches"
);

const headers = {
    "Authorization": "Bearer {YOUR_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};


fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

List company attendance records, filterable by date range.

requires authentication

Example request:

curl --request GET \
    --get "https://hr.getokta.io/api/v1/attendance-records" \
    --header "Authorization: Bearer {YOUR_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"from\": \"2026-07-02T12:44:20\",
    \"to\": \"2026-07-02T12:44:20\",
    \"employee_id\": 16
}"

const url = new URL(
    "https://hr.getokta.io/api/v1/attendance-records"
);

const headers = {
    "Authorization": "Bearer {YOUR_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "from": "2026-07-02T12:44:20",
    "to": "2026-07-02T12:44:20",
    "employee_id": 16
};

fetch(url, {
    method: "GET",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Request

GET api/v1/attendance-records

Headers

Authorization

Example: Bearer {YOUR_TOKEN}

Content-Type

Example: application/json

Accept

Example: application/json

Body Parameters

from string optional

Must be a valid date. Example: 2026-07-02T12:44:20

to string optional

Must be a valid date. Example: 2026-07-02T12:44:20

employee_id integer optional

Example: 16

List company leave requests (HR/manager).

requires authentication

Example request:

curl --request GET \
    --get "https://hr.getokta.io/api/v1/leave-requests" \
    --header "Authorization: Bearer {YOUR_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "https://hr.getokta.io/api/v1/leave-requests"
);

const headers = {
    "Authorization": "Bearer {YOUR_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};


fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Act on the current approval step (approve|reject).

requires authentication

Example request:

curl --request POST \
    "https://hr.getokta.io/api/v1/leave-requests/1/act" \
    --header "Authorization: Bearer {YOUR_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"decision\": \"reject\",
    \"notes\": \"b\"
}"

const url = new URL(
    "https://hr.getokta.io/api/v1/leave-requests/1/act"
);

const headers = {
    "Authorization": "Bearer {YOUR_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "decision": "reject",
    "notes": "b"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Request

POST api/v1/leave-requests/{leaveRequest_id}/act

Headers

Authorization

Example: Bearer {YOUR_TOKEN}

Content-Type

Example: application/json

Accept

Example: application/json

URL Parameters

leaveRequest_id integer

The ID of the leaveRequest. Example: 1

Body Parameters

decision string

Example: reject

Must be one of:

approve
reject

notes string optional

Must not be greater than 255 characters. Example: b

List payroll runs (HR only).

requires authentication

Example request:

curl --request GET \
    --get "https://hr.getokta.io/api/v1/payroll-runs" \
    --header "Authorization: Bearer {YOUR_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "https://hr.getokta.io/api/v1/payroll-runs"
);

const headers = {
    "Authorization": "Bearer {YOUR_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};


fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

A run with its employee lines.

requires authentication

Example request:

curl --request GET \
    --get "https://hr.getokta.io/api/v1/payroll-runs/16" \
    --header "Authorization: Bearer {YOUR_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "https://hr.getokta.io/api/v1/payroll-runs/16"
);

const headers = {
    "Authorization": "Bearer {YOUR_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};


fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Request

GET api/v1/payroll-runs/{payrollRun_id}

Headers

Authorization

Example: Bearer {YOUR_TOKEN}

Content-Type

Example: application/json

Accept

Example: application/json

URL Parameters

payrollRun_id integer

The ID of the payrollRun. Example: 16

List company assets with their current holder.

requires authentication

Example request:

curl --request GET \
    --get "https://hr.getokta.io/api/v1/assets" \
    --header "Authorization: Bearer {YOUR_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "https://hr.getokta.io/api/v1/assets"
);

const headers = {
    "Authorization": "Bearer {YOUR_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};


fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Published company announcements.

requires authentication

Example request:

curl --request GET \
    --get "https://hr.getokta.io/api/v1/announcements" \
    --header "Authorization: Bearer {YOUR_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "https://hr.getokta.io/api/v1/announcements"
);

const headers = {
    "Authorization": "Bearer {YOUR_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};


fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

The authenticated user's attendance records for a month (?month=YYYY-MM).

requires authentication

Example request:

curl --request GET \
    --get "https://hr.getokta.io/api/v1/me/attendance" \
    --header "Authorization: Bearer {YOUR_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "https://hr.getokta.io/api/v1/me/attendance"
);

const headers = {
    "Authorization": "Bearer {YOUR_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};


fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Mobile check-in with geofence validation against the branch.

requires authentication

Example request:

curl --request POST \
    "https://hr.getokta.io/api/v1/me/attendance/check-in" \
    --header "Authorization: Bearer {YOUR_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"latitude\": -89,
    \"longitude\": -179
}"

const url = new URL(
    "https://hr.getokta.io/api/v1/me/attendance/check-in"
);

const headers = {
    "Authorization": "Bearer {YOUR_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "latitude": -89,
    "longitude": -179
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Request

POST api/v1/me/attendance/check-in

Headers

Authorization

Example: Bearer {YOUR_TOKEN}

Content-Type

Example: application/json

Accept

Example: application/json

Body Parameters

latitude number optional

Must be between -90 and 90. Example: -89

longitude number optional

Must be between -180 and 180. Example: -179

Mobile check-out.

requires authentication

Example request:

curl --request POST \
    "https://hr.getokta.io/api/v1/me/attendance/check-out" \
    --header "Authorization: Bearer {YOUR_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"latitude\": -89,
    \"longitude\": -179
}"

const url = new URL(
    "https://hr.getokta.io/api/v1/me/attendance/check-out"
);

const headers = {
    "Authorization": "Bearer {YOUR_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "latitude": -89,
    "longitude": -179
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Request

POST api/v1/me/attendance/check-out

Headers

Authorization

Example: Bearer {YOUR_TOKEN}

Content-Type

Example: application/json

Accept

Example: application/json

Body Parameters

latitude number optional

Must be between -90 and 90. Example: -89

longitude number optional

Must be between -180 and 180. Example: -179

The authenticated employee's leave requests.

requires authentication

Example request:

curl --request GET \
    --get "https://hr.getokta.io/api/v1/me/leaves" \
    --header "Authorization: Bearer {YOUR_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "https://hr.getokta.io/api/v1/me/leaves"
);

const headers = {
    "Authorization": "Bearer {YOUR_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};


fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Submit a leave request (enters the approval chain).

requires authentication

Example request:

curl --request POST \
    "https://hr.getokta.io/api/v1/me/leaves" \
    --header "Authorization: Bearer {YOUR_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"leave_type_id\": \"architecto\",
    \"start_date\": \"2052-07-25\",
    \"end_date\": \"2052-07-25\",
    \"reason\": \"n\"
}"

const url = new URL(
    "https://hr.getokta.io/api/v1/me/leaves"
);

const headers = {
    "Authorization": "Bearer {YOUR_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "leave_type_id": "architecto",
    "start_date": "2052-07-25",
    "end_date": "2052-07-25",
    "reason": "n"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Request

POST api/v1/me/leaves

Headers

Authorization

Example: Bearer {YOUR_TOKEN}

Content-Type

Example: application/json

Accept

Example: application/json

Body Parameters

leave_type_id string

Example: architecto

start_date string

Must be a valid date. Must be a date after or equal to today. Example: 2052-07-25

end_date string

Must be a valid date. Must be a date after or equal to start_date. Example: 2052-07-25

reason string optional

Must not be greater than 255 characters. Example: n

Current-year leave balances.

requires authentication

Example request:

curl --request GET \
    --get "https://hr.getokta.io/api/v1/me/leave-balances" \
    --header "Authorization: Bearer {YOUR_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "https://hr.getokta.io/api/v1/me/leave-balances"
);

const headers = {
    "Authorization": "Bearer {YOUR_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};


fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

The authenticated employee's payslips from closed runs.

requires authentication

Example request:

curl --request GET \
    --get "https://hr.getokta.io/api/v1/me/payslips" \
    --header "Authorization: Bearer {YOUR_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "https://hr.getokta.io/api/v1/me/payslips"
);

const headers = {
    "Authorization": "Bearer {YOUR_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};


fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

The user's in-app notifications.

requires authentication

Example request:

curl --request GET \
    --get "https://hr.getokta.io/api/v1/me/notifications" \
    --header "Authorization: Bearer {YOUR_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "https://hr.getokta.io/api/v1/me/notifications"
);

const headers = {
    "Authorization": "Bearer {YOUR_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};


fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Mark one (or all) notifications as read.

requires authentication

Example request:

curl --request POST \
    "https://hr.getokta.io/api/v1/me/notifications/read" \
    --header "Authorization: Bearer {YOUR_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"id\": \"architecto\"
}"

const url = new URL(
    "https://hr.getokta.io/api/v1/me/notifications/read"
);

const headers = {
    "Authorization": "Bearer {YOUR_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "id": "architecto"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Request

POST api/v1/me/notifications/read

Headers

Authorization

Example: Bearer {YOUR_TOKEN}

Content-Type

Example: application/json

Accept

Example: application/json

Body Parameters

id string optional

Example: architecto

GET api/internal/companies

requires authentication

Example request:

curl --request GET \
    --get "https://hr.getokta.io/api/internal/companies" \
    --header "Authorization: Bearer {YOUR_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "https://hr.getokta.io/api/internal/companies"
);

const headers = {
    "Authorization": "Bearer {YOUR_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};


fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
x-ratelimit-limit: 120
x-ratelimit-remaining: 119
access-control-allow-origin: *


{
    "message": "Invalid service key."
}

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

GET api/internal/companies/{company_id}/employees

requires authentication

Example request:

curl --request GET \
    --get "https://hr.getokta.io/api/internal/companies/1/employees" \
    --header "Authorization: Bearer {YOUR_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "https://hr.getokta.io/api/internal/companies/1/employees"
);

const headers = {
    "Authorization": "Bearer {YOUR_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};


fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
x-ratelimit-limit: 120
x-ratelimit-remaining: 119
access-control-allow-origin: *


{
    "message": "Invalid service key."
}

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Request

GET api/internal/companies/{company_id}/employees

Headers

Authorization

Example: Bearer {YOUR_TOKEN}

Content-Type

Example: application/json

Accept

Example: application/json

URL Parameters

company_id integer

The ID of the company. Example: 1

GET api/internal/companies/{company_id}/departments

requires authentication

Example request:

curl --request GET \
    --get "https://hr.getokta.io/api/internal/companies/1/departments" \
    --header "Authorization: Bearer {YOUR_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "https://hr.getokta.io/api/internal/companies/1/departments"
);

const headers = {
    "Authorization": "Bearer {YOUR_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};


fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
x-ratelimit-limit: 120
x-ratelimit-remaining: 119
access-control-allow-origin: *


{
    "message": "Invalid service key."
}

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Request

GET api/internal/companies/{company_id}/departments

Headers

Authorization

Example: Bearer {YOUR_TOKEN}

Content-Type

Example: application/json

Accept

Example: application/json

URL Parameters

company_id integer

The ID of the company. Example: 1

Introduction

Authenticating requests

Endpoints

Issue a Sanctum token for the mobile app / API consumers.

Request Try it out ⚡ Cancel 🛑 Send Request 💥

Headers

Body Parameters

Revoke the token used for the current request.

Request Try it out ⚡ Cancel 🛑 Send Request 💥

Headers

The authenticated user's profile (mobile self-service).

Request Try it out ⚡ Cancel 🛑 Send Request 💥

Headers

List employees (paginated, filterable by status and search).

Request Try it out ⚡ Cancel 🛑 Send Request 💥

Headers

Show a single employee.

Request Try it out ⚡ Cancel 🛑 Send Request 💥

Headers

URL Parameters

List all departments of the current company.

Request Try it out ⚡ Cancel 🛑 Send Request 💥

Headers

List all branches of the current company.

Request Try it out ⚡ Cancel 🛑 Send Request 💥

Headers

List company attendance records, filterable by date range.

Request Try it out ⚡ Cancel 🛑 Send Request 💥

Headers

Body Parameters

List company leave requests (HR/manager).

Request Try it out ⚡ Cancel 🛑 Send Request 💥

Headers

Act on the current approval step (approve|reject).

Request Try it out ⚡ Cancel 🛑 Send Request 💥

Headers

URL Parameters

Body Parameters

List payroll runs (HR only).

Request Try it out ⚡ Cancel 🛑 Send Request 💥

Headers

A run with its employee lines.

Request Try it out ⚡ Cancel 🛑 Send Request 💥

Headers

URL Parameters

List company assets with their current holder.

Request Try it out ⚡ Cancel 🛑 Send Request 💥

Headers

Published company announcements.

Request Try it out ⚡ Cancel 🛑 Send Request 💥

Headers

The authenticated user's attendance records for a month (?month=YYYY-MM).

Request Try it out ⚡ Cancel 🛑 Send Request 💥

Headers

Mobile check-in with geofence validation against the branch.

Request Try it out ⚡ Cancel 🛑 Send Request 💥

Headers

Body Parameters

Mobile check-out.

Request Try it out ⚡ Cancel 🛑 Send Request 💥

Headers

Body Parameters

The authenticated employee's leave requests.

Request Try it out ⚡ Cancel 🛑 Send Request 💥

Headers

Submit a leave request (enters the approval chain).

Request Try it out ⚡ Cancel 🛑 Send Request 💥

Headers

Body Parameters

Current-year leave balances.

Request Try it out ⚡ Cancel 🛑 Send Request 💥

Headers

The authenticated employee's payslips from closed runs.

Request Try it out ⚡ Cancel 🛑 Send Request 💥

Headers

The user's in-app notifications.

Request Try it out ⚡ Cancel 🛑 Send Request 💥

Headers

Mark one (or all) notifications as read.

Request Try it out ⚡ Cancel 🛑 Send Request 💥

Request

Request

Request

Request

Request

Request

Request

Request

Request

Request

Request

Request

Request

Request

Request

Request

Request

Request

Request

Request

Request

Request

Request

Request

Request

Request