List Job roles
/unified/hris/job_roles
Partial response — use the "get" endpoint for the full object.
Query Parameters
Refer Specifying query parameters in Truto APIs
2 supported2 notes
The company to use, referencing companies.id. Optional: when omitted the account's company is looked up automatically. The request fails if the account can see more than one company and none is given.
The Paychex company to use, referencing companies.id (Paychex companyId). A company pinned on the connection (company_id in the integrated account context) always wins and this parameter is then ignored. Otherwise, when omitted, the credential's companies are looked up and the single company with API permission is used. The request fails with a 400 when no company can be resolved (the credential sees more than one company with API permission, none, or 100 or more companies).
Flat alternative to company.id.
2 supported
Filter by the 7shifts location the record belongs to, referencing locations.id.
1 supported
Flat alternative to location.id.
1 supported
Filter by the department (groups.id) the role belongs to.
1 supported
Flat alternative to group.id.
1 supported
This represents the date when the job roles was updated
2 supported2 notes
Return records modified on or after this date. Accepts an ISO date-time string, or an object with gte or gt. The bound is inclusive: gt is treated as gte. 7shifts filters by date only, so the value is converted to its UTC date and the time part is then ignored.
Filter by this timestamp. Accepts either a plain ISO date-time string (implies >=), or an object with gt/gte/lt/lte keys for a range.
Filter by this timestamp. Accepts either a plain ISO date-time string (implies >=), or an object with gt/gte/lt/lte keys for a range.
1 supported
This represents the name of the job role
3 supported2 notes
Filter by job profile title. Exact, whole-value match sent as the OData filter title eq '' (Kallidus has no partial match; case sensitivity is not documented). Combined with the other filters using and. Several values mean any of them: Kallidus has no or, so no title condition is sent and this mapping keeps the matching records itself (comparing case-insensitively) — a page can come back short or empty while next_cursor continues, so keep paging until next_cursor is null. The other filters still narrow the query at Kallidus. Accepted forms: name=, name[]= or a repeated name, name[eq]= and name[in]=a,b, all meaning any of the values. name[ne] and name[nin] are refused: Kallidus documents the OData ne operator for users only. A comma separates values only inside [in]; anywhere else it is part of the value. Any other form (name[gte], name[like], ...) is refused with a 400 instead of being dropped.
Passed to Sesame's name filter (Find job charges by name; whether it matches exactly or partially is not documented). Sesame's name filter takes one value, so several are refused (400). Accepts a plain value, a comma-separated list, repeated keys and [eq]/[in]; any other operator is refused (400) rather than dropped.
The employee (employees.id). Required: Remote has no company-wide job catalogue, so this returns the job assigned to that employment.
1 supported1 required
Flat alternative to employee.id.
1 supported
Return the record as it is effective on this date (YYYY-MM-DD; a date-time's time part is ignored). Defaults to today's UTC date. UKG business-structure records are effective-dated and UKG requires a date. Accepts a date or date-time string (only the date part is used) or an eq filter; a value that is not a date is refused with 400 rather than ignored.
1 supported
Also return inactive job profiles (Workday default: active only).
1 supported
Show Truto-specific parameters
The ID of the integrated account to use for the request.
62f44730-dd91-461e-bd6a-aedd9e0ad79dThe format of the response.
unifiedreturns the response with unified mappings applied.rawreturns the unprocessed, raw response from the remote API.normalizedapplies the unified mappings and returns the data in a normalized format.streamreturns the response as a stream, which is ideal for transmitting large datasets, files, or binary data. Using streaming mode helps to efficiently handle large payloads or real-time data flows without requiring the entire data to be buffered in memory.debugreturns the final unified result alongside raw remote fetch information. The response is an envelope containingresult(identical to unified mode output) anddebug(withrequestUrl,requestOptions,data,responseHeaders, and for list operations:nextCursor,isLooping,isEmptyResult,resultCount). When the upstream body exceeds 1 MiB,datais replaced by{ truto_truncated: true, truto_max_bytes, truto_excerpt }.debugisnullfor static responses or whentruto_skip_api_call=true.
Defaults to unified.
unifiedunifiedrawnormalizedstreamdebug
By default the result attribute is an array of objects. This parameter allows you to specify a field in each result objects to use as key, which transforms the result array into an object with the array items keyed by the field. This is useful for when you want to use the result as a lookup table.
idIgnores the limit query parameter.
Excludes the remote_data attribute from the response.
Array of fields to exclude from the response.
truto_exclude_fields[]=id&truto_exclude_fields[]=nameQuery parameters to pass to the underlying API without any transformations. Refer this guide to see how to structure the query parameters.
remote_query[foo]=barResponse Body
Present only when truto_response_format=debug. Contains raw fetch details: requestUrl, requestOptions, data, responseHeaders, nextCursor, isLooping, isEmptyResult, resultCount. data is the parsed upstream body; when its JSON form exceeds 1 MiB it is replaced by { truto_truncated: true, truto_max_bytes, truto_excerpt }, where truto_excerpt is the leading bytes of that body. The same applies to a string requestOptions.body. null for static responses or when truto_skip_api_call=true.
The cursor to use for the next page of results. Pass this value as next_cursor in the query parameter in the next request to get the next page of results.
List of Job roles
The unique identifier for job roles
16 supported
This represents the date when the job roles was created
3 supported
This represents the description of the job role
5 supported
This represents the name of the job role
16 supported
Raw data returned from the remote API call.
This represents the date when the job roles was updated
3 supported
truto unified hris jobroles \
-a '<integrated_account_id>' \
-o jsonimport Truto from '@truto/truto-ts-sdk';
const truto = new Truto({
token: '<your_api_token>',
});
const result = await truto.unifiedApi.list(
'hris',
'jobroles',
{ integrated_account_id: '<integrated_account_id>' }
);
console.log(result);import asyncio
from truto_python_sdk import TrutoApi
truto_api = TrutoApi(token="<your_api_token>")
async def main():
async for item in truto_api.unified_api.list(
"hris",
"jobroles",
{"integrated_account_id": "<integrated_account_id>"}
):
print(item)
asyncio.run(main())curl -X GET 'https://api.truto.one/unified/hris/job_roles?integrated_account_id=<integrated_account_id>' \
-H 'Authorization: Bearer <your_api_token>' \
-H 'Content-Type: application/json'const integratedAccountId = '<integrated_account_id>';
const response = await fetch(`https://api.truto.one/unified/hris/job_roles?integrated_account_id=${integratedAccountId}`, {
method: 'GET',
headers: {
'Authorization': 'Bearer <your_api_token>',
'Content-Type': 'application/json',
},
});
const data = await response.json();
console.log(data);import requests
url = "https://api.truto.one/unified/hris/job_roles"
headers = {
"Authorization": "Bearer <your_api_token>",
"Content-Type": "application/json",
}
params = {
"integrated_account_id": "<integrated_account_id>"
}
response = requests.get(url, headers=headers, params=params)
print(response.json())