API docs by Redocly

Worker Management (2026-05-08)

Download OpenAPI specification:Download

License: Trade secret

The Avetta API is a mechanism to allow our customers to retrieve worker data from Worker Management via application programming interface. The Avetta WM API is organized around REST and uses HTTP status codes and error payload responses to indicate API errors.

We leverage the HTTP protocol features, like HTTP verbs and status codes, which are commonly used and are understood by off-the-shelf HTTP clients. All API responses (including errors) will be returned in JSON format. All API responses we process will return 200 but include the status code in the payload returned.

Host Region

In some cases we support regional instances. The default region value is simply 'worker'. Making the host value evaluate to https://worker.avetta.com. If told to use a regional url, other than the default, append the region identifier after worker. eg. https://worker-au.avetta.com

Versioning <- IMPORTANT UPDATE MUST READ ->

You will notice in this documentation that the URL for this API is as follows: https://worker.avetta.com/api/vX… This URL contains vX to specify the particular version to be used when making the desired call. Different versions of the same endpoint may return different results, therefore it is important to note the versions of each endpoint in this documentation. Please be aware of this as you check each endpoint.

Authentication

When using the API, include your secret API key in the Authorization request header for the service to authenticate your account. This API Key will be provided to you by your point of contact in Avetta.

The Authorization header must be formatted as:

Authorization: apikey <key>

All API requests must be made over HTTPS. Calls to the service over HTTP will result in a 302 Redirect response to the HTTPS end-point. API requests without an Authorization: apikey <key> header will fail.

Errors

Worker Management returns 2xx response codes on all responses handled by system. If the call fails, you will get a 5xx response code. For errors, we return a status code on the page with the 4xx response code.

Pagination

Avetta has a default maximum limit of 3000 results in one API call. In the case where the response returns more than the default limit, you must utilize pagination to retrieve the full data set. Avetta utilizes cursor-based pagination via optional start and limit query string parameters. The start indicates the record to start with for pagination and the limit indicates the total number of records to return (maximum of 3000).

Accounts

The Accounts API allows you to retrieve account information.

List of accounts to client

Returns a list of accounts to client

Authorizations:
ApiKeyAuth
path Parameters
id
integer

references an id to reduce list down to 1 item

query Parameters
start
integer
Default: 1

Offset of the first record to return

limit
integer
Default: 3000

Maximum number of records to return

search
string

Search term - check for the code and title

sort
string
Enum: "id" "code" "title" "group"

Name of field to sort by

type
string
Enum: "client" "supplier" "supplierSubcontractor"

Type of the account

modifiedAfter
string <date-time>

Modified after

extra
string
Enum: "users" "connections" "admins"

Extra??

role_id
integer

Show the users with the specified role ID

showInactive
boolean
Enum: true false

Show inactive

flag
string
Enum: "Green" "Amber" "Red"

Flag

Responses

Response samples

Content type
application/json
Example
{
  • "stats": {
    },
  • "accounts": [
    ]
}

Admin

The Admin API provides administrative endpoints for system overview and management data. Access requires appropriate security permissions.

Administrative Overview

Returns administrative overview with counts of various system components that the admin can see based on their security permissions

Authorizations:
ApiKeyAuth

Responses

Response samples

Content type
application/json
Example
{
  • "overview": {
    },
  • "stats": {
    }
}

Auth

The Auth API allows you to authenticate into Worker Management. Handles multi-factor authentication, password reset, and single sign-on.

Authentication (Deprecated) Deprecated

Deprecated. Do not use for new integrations - use /auth/token instead. Get the token for the user.

query Parameters
username
required
string <string>

Username of the user to authenticate with

newpassword
required
string <string>

Password of the user to authenticate with

Responses

Response samples

Content type
application/json
{
  • "stats": {
    },
  • "auth": {
    }
}

Token generation

Generate or refresh security tokens (Access and Refresh) for the user, for both Connect and WM.

Request Body schema:
grant_type
required
string
Value: "password"

Type of access requested. For new tokens, use 'password'.

username
required
string <string>

Username of the user.

password
required
string <string>

Password of the user.

device
required
string <string>

ID of the device.

Responses

Response samples

Content type
application/json
Example
{
  • "stats": {
    },
  • "tokens": {
    }
}

SSO Check

Get if the Credentials is a SSO user

query Parameters
username
required
string <string>

Username of the user

isMobile
integer <int64>
Enum: 0 1

Is mobile device

Responses

Response samples

Content type
application/json
Example
{
  • "stats": {
    },
  • "auth": {}
}

Logout user

Logout the user. This endpoint is public - the token to invalidate can be provided either via the Authorization header (apikey <key>) or in the request body (wm_access_token / connect_access_token). If a Worker Management token is provided in the header the request body is optional and the call can be a normal GET.

Authorizations:
ApiKeyAuthNone
Request Body schema: multipart/form-data (WM & Connect)
wm_access_token
string <string>

Worker Management access token

connect_access_token
string <string>

Connect access token

Responses

Response samples

Content type
application/json
Example
{
  • "stats": {
    },
  • "auth": {
    }
}

Request reset password

Send an email to the user with a link to reset the password. Works for both Connect and Worker Management users

query Parameters
username
required
string <string>

Username of the user

Responses

Response samples

Content type
application/json
Example
{
  • "stats": {
    },
  • "auth": {
    }
}

Switch user

Switch the user to the given user when the user has permission to do it

Authorizations:
ApiKeyAuth
query Parameters
username
required
string <string>

Username of the user to switch

Responses

Response samples

Content type
application/json
{
  • "stats": {
    },
  • "switch_user": {
    }
}

Update Password

Update the password of a user, either in Worker Management or in Connect

query Parameters
newpassword
required
string <string>

New password for the user

passwordhint
string <string>

Password hint to associate with the new password. Not used for Connect passwords.

key
required
string <string>

Token that was sent by email to perform the password change

Responses

Response samples

Content type
application/json
Example
{
  • "stats": {
    },
  • "auth": {
    }
}

Validate an email change

Perform a validation of a change to the user's email address based on a code sent to the email address

query Parameters
bnm
required
string <string>

Security code for the email change. This code is sent to the new email address set by the user.

password
required
string <string>

Password of the account that is getting its email address updated

Responses

Response samples

Content type
application/json
Example
{
  • "stats": {
    },
  • "auth_validateemail": {
    }
}

Generate MFA code

Generate the MFA code and send it to the user via email or phone

Authorizations:
ApiKeyAuth
query Parameters
method
string^[a-zA-Z]+$
Enum: "email" "phone"

method to validate the user (email or phone)

wm_jwt
string <string>

Worker Management JWT token

connect_jwt
string <string>

Connect JWT token (required when validating a Connect MFA token)

UsrMobilePhone
string <string>

Phone number to validate user against

UsrEmailAddr
string <string>

Email address to validate user against

Responses

Response samples

Content type
application/json
{
  • "stats": {
    },
  • "mfa": {
    }
}

Validate MFA code

Validate the MFA code is correct

Authorizations:
ApiKeyAuth
query Parameters
code
required
integer <integer>

Code to validate the user received in email or phone

method
string
Enum: "email" "phone"

Delivery method used (required when validating a Connect token). Expected email or phone

wm_jwt
string <string>

Worker Management JWT token

connect_jwt
string <string>

Connect JWT token (required when validating a Connect MFA token)

Responses

Response samples

Content type
application/json
Example
{
  • "stats": {
    },
  • "mfa": {
    }
}

Get MFA info

Get information about the current user's MFA status.

Authorizations:
ApiKeyAuth

Responses

Response samples

Content type
application/json
{
  • "summary": "Successful MFA info",
  • "value": {
    }
}

Countries

The Countries API allows you to retrieve country information. Get country data, dialing codes, and more.

List of countries

Returns a list of countries

Authorizations:
ApiKeyAuth

Responses

Response samples

Content type
application/json
{
  • "stats": {
    },
  • "countries": [
    ]
}

Get country by id or code

Returns the information of the country with the given id

Authorizations:
ApiKeyAuth
path Parameters
id
integer

references an id to reduce list down to 1 item

Responses

Response samples

Content type
application/json
{
  • "stats": {
    },
  • "countries": {
    }
}

Event

The Event API allows you to retrieve event / requirement information.

List of events

Returns responses of event

Authorizations:
ApiKeyAuth
path Parameters
id
integer

references an id to reduce list down to 1 item

Responses

Response samples

Content type
application/json
Example

Could be any Requirement type (AICC, Download, External, Order, Register, Run, SCORM)

{
  • "stats": {
    },
  • "event": {
    }
}

Clear the SCORM bookmarks.

This endpoint is used to clear the SCORM bookmarks.

Authorizations:
ApiKeyAuth
query Parameters
evtID
required
integer <integer>

Number of the Event ID

Responses

Response samples

Content type
application/json
Example
{
  • "stats": {
    },
  • "event/clearbookmark": {
    }
}

Complete / Mark as Downloaded

This endpoint is used to mark the requirement files as Viewed / Downloaded. The list of available files can be found under “links” array returned by the Event endpoint

Authorizations:
ApiKeyAuth
query Parameters
EvtID
required
integer <int64>

Number of the Event ID, returned by the Get Event Endpoint (“id” attribute)

FileName
string <string>

Name of the file, can be found in the “links” array, “title” attribute

Responses

Response samples

Content type
application/json
{
  • "stats": {
    },
  • "event_document": {
    }
}

Upload a document (using form-data)

This endpoint is used to upload a document for “Documents Review” section. The uploaded documents can be found in the “upload->files” array returned by the Event endpoint

Authorizations:
ApiKeyAuth
query Parameters
EvtID
required
integer <int64>

Number of the Event ID, returned by the Get Event Endpoint (“id” attribute)

DocFile
string <string>

Actual content of the Document File reference using “form-data”

FileName
object <object>

A JSON with “base64string”, “filename” is required in the “raw” body.

Responses

Response samples

Content type
application/json
Example
{
  • "stats": {
    },
  • "event_document": {
    }
}

Delete a document

This endpoint is used to delete a document uploaded for “Documents Review”

Authorizations:
ApiKeyAuth
query Parameters
EvtID
required
integer <int64>

Number of the Event ID, returned by the Get Event Endpoint (“id” attribute)

DocID
integer <int64>

Number ID of the document

UEDID
integer <int64>

Number of User Event Document, can be found in the “files” array, “id” attribute.

Responses

Response samples

Content type
application/json
{
  • "stats": {
    },
  • "event_document": {
    }
}

Get a document (using base64string)

This is NOT a preferred method. Mobile team should NOT use this method This endpoint is used to get a document uploaded for “Documents Review” to download

Authorizations:
ApiKeyAuth
query Parameters
EvtID
required
integer <int64>

Number of the Event ID, returned by the Get Event Endpoint (“id” attribute)

DocID
integer <int64>

Number ID of the document

UEDID
integer <int64>

Number of User Event Document, can be found in the “files” array, “id” attribute.

Responses

Response samples

Content type
application/json
{
  • "stats": {
    },
  • "event_document": {
    }
}

Event Review

Endpoint to save the event for Credit/review

Authorizations:
ApiKeyAuth
query Parameters
EvtID
required
integer <int64>

Event ID

POSTDATA
string <string>

POSTDATA

Responses

Response samples

Content type
application/json
{
  • "stats": {
    },
  • "event/review": {
    }
}

Events

The Events API allows you to list events.

List of events

Returns a list of events based on the user Reports permission, if the user is a worker, it will return the events that are applicable to the worker

Authorizations:
ApiKeyAuth
query Parameters
start
integer
Default: 1

Offset of the first record to return

limit
integer
Default: 3000

Maximum number of records to return

search
string

Search term for the event title

type
string
Enum: "requirement" "track" "job" "survey" "equivalency" "optin"

List of event types contatenated by comma ( requirement,equivalency )

user_id
integer

Filters the list of events to show only those applicable to the user

showAll
integer
Enum: 0 1

1 to show all events, 0 to show only the ones in use, 0 is the default

site
integer

Filters viewing based on the site

showInactive
integer
Enum: 0 1

1 to show inactive events, 0 to not show inactive events, 0 is the default

Responses

Response samples

Content type
application/json
{
  • "stats": {
    },
  • "events": [
    ]
}

List of events for variances

Returns a list of events based on the Variances permission

Authorizations:
ApiKeyAuth
query Parameters
start
integer
Default: 1

Offset of the first record to return

limit
integer
Default: 3000

Maximum number of records to return

search
string

Search term for the event title

type
string
Enum: "requirement" "track" "job" "survey" "equivalency" "optin"

List of event types contatenated by comma ( requirement,equivalency )

user_id
integer

Filters the list of events to show only those applicable to the user

showAll
integer
Enum: 0 1

1 to show all events, 0 to show only the ones in use, 0 is the default

site
integer

Filters viewing based on the site

showInactive
integer
Enum: 0 1

1 to show inactive events, 0 to not show inactive events, 0 is the default

Responses

Response samples

Content type
application/json
{
  • "stats": {
    },
  • "events": [
    ]
}

List of events for credit

Returns a list of events based on the Credit permission

Authorizations:
ApiKeyAuth
query Parameters
start
integer
Default: 1

Offset of the first record to return

limit
integer
Default: 3000

Maximum number of records to return

search
string

Search term for the event title

type
string
Enum: "requirement" "track" "job" "survey" "equivalency" "optin"

List of event types contatenated by comma ( requirement,equivalency )

user_id
integer

Filters the list of events to show only those applicable to the user

showAll
integer
Enum: 0 1

1 to show all events, 0 to show only the ones in use, 0 is the default

site
integer

Filters viewing based on the site

showInactive
integer
Enum: 0 1

1 to show inactive events, 0 to not show inactive events, 0 is the default

Responses

Response samples

Content type
application/json
{
  • "stats": {
    },
  • "events": [
    ]
}

List of electives events

Returns a list of elective events for the given user

Authorizations:
ApiKeyAuth
query Parameters
start
integer
Default: 1

Offset of the first record to return

limit
integer
Default: 3000

Maximum number of records to return

search
string

Search term for the event title

site
integer

Filters viewing based on the site

Responses

Response samples

Content type
application/json
{
  • "stats": {
    },
  • "events": [
    ]
}

Credit

The endpoints to credit events.

Return the credit form for the event

This endpoint will return a list of fields, prereqs or items to be filled in order to credit the event

Authorizations:
ApiKeyAuth
path Parameters
EvtID
required
integer <int64>

Event ID

query Parameters
user_id
required
integer <int64>

User ID

Responses

Response samples

Content type
application/json
{
  • "stats": {
    },
  • "event_credit": {
    }
}

Credit requirements

Credits the user for the requirement

Authorizations:
ApiKeyAuth
path Parameters
EvtID
required
integer <int64>

Event ID

query Parameters
user_id
required
integer <int64>

User ID

srch_id
required
integer <int64>

Search ID

expiredate
string <date>

Expire date could be required or not

datetime
string <date-time>

Date and time of the event, it could be required or not

NewUEDRevNotes
string

Review notes

UEDRevInstructor
string

Instructor, it could be required or not depending on the requirement configuration

result
integer <int64>
Enum: 201 202

Result of the requirement (201 - Passed, 202 - Failed)

score
number <number>

Score of the requirement (0 - 100)

cost
number <number>

Cost of the requirement

hours
number <number>

Duration of the requirement

notes
string

Aditional notes of the requirement

customField
string

Additional fields configured for the requirement

Responses

Response samples

Content type
application/json
Example
{
  • "stats": {
    },
  • "events_credit": {
    }
}

Upload a temporal file for credit

Upload a temporal file for credit

Authorizations:
ApiKeyAuth
path Parameters
EvtID
required
integer <int64>

Event ID

query Parameters
user_id
required
integer <int64>

User ID

srch_id
required
integer <int64>

Search ID

Request Body schema: multipart/form-data
doc_file
string <binary>

Responses

Response samples

Content type
application/json
Example
{
  • "stats": {
    },
  • "events_credit": {
    }
}

Return the temporal files for credit

Return the temporal files for credit

Authorizations:
ApiKeyAuth
path Parameters
EvtID
required
integer <int64>

Event ID

query Parameters
user_id
required
integer <int64>

User ID

srch_id
required
integer <int64>

Search ID

Responses

Response samples

Content type
application/json
{
  • "stats": {
    },
  • "event_credit": {
    }
}

Delete a temporal file for credit

Delete a temporal file for credit

Authorizations:
ApiKeyAuth
path Parameters
EvtID
required
integer <int64>

Event ID

query Parameters
doc_id
integer <int64>

The DocUID of the file to be deleted

filename
string

The file name of the file to be deleted

srch_id
required
integer <int64>

Search ID

user_id
required
integer <int64>

User ID

Responses

Response samples

Content type
application/json
Example
{
  • "stats": {
    },
  • "events_credit": {
    }
}

Languages

The Languages API allows you to retrieve language information.

List of languages

Returns the information of the language with the given language code

Authorizations:
ApiKeyAuth
path Parameters
lngCode
required
string

Language code to filter the results

Responses

Response samples

Content type
application/json
{
  • "stats": {
    },
  • "languages": {
    }
}

List of language strings by locale

Returns the list of strings for the given language code filtered by the given string portion if provided

Authorizations:
ApiKeyAuth
path Parameters
lngCode
required
string

Language code to filter the results

lngString
string

Language string to filter the results (could be a portion of the string)

Responses

Response samples

Content type
application/json
{
  • "stats": {
    },
  • "strings": {
    }
}

Registration

The Registration API allows you to register a new account or user.

List of pending registration requests

Returns a list of all workers that have pending registration requests

Authorizations:
ApiKeyAuth
query Parameters
start
integer
Default: 1

Offset of the first record to return

limit
integer
Default: 3000

Maximum number of records to return

sort
string
Enum: "first" "last" "date"

Name of field to sort by

search
string

Search term - check for the code and title

Responses

Response samples

Content type
application/json
{
  • "stats": {
    },
  • "requests": [
    ]
}

Total count of pending registration requests

Returns the total number of pending requests

Authorizations:
ApiKeyAuth

Responses

Response samples

Content type
application/json
{
  • "stats": {
    },
  • "requests": 5
}

Details of the pending registration request, user information, sites and roles

Returns the details of a pending registration request

Authorizations:
ApiKeyAuth
path Parameters
id
required
integer

ID of pending registration request

Responses

Response samples

Content type
application/json
{
  • "stats": {
    },
  • "requests": [
    ]
}

Approves a registration request

Approves a pending registration request based on the request ID

Authorizations:
ApiKeyAuth
path Parameters
id
required
integer

ID of pending registration request

Responses

Response samples

Content type
application/json
{
  • "stats": {
    },
  • "requests": {
    }
}

Denies a registration request

Denies a pending registration request based on the request ID

Authorizations:
ApiKeyAuth
path Parameters
id
required
integer

ID of pending registration request

Responses

Response samples

Content type
application/json
{
  • "stats": {
    },
  • "requests": {
    }
}

The Registration API allows you to register a new user.

This endpoint allows you to register a new user.

Authorizations:
ApiKeyAuth
query Parameters
invitecode
required
string <string>

Invitation code

Request Body schema: text/json
required

User data to insert with self registration

login_id
string

( Required ) Login ID of the user registering

password
string

( Required ) Password of the user registering

first_name
string

( Required ) First Name of the user registering

last_name
string

( Required ) Last Name of the user registering

email
string

Email Address of the user registering

object

Data of the account registering

locale
string

Locale of the user registering

Responses

Request samples

Content type
text/json
{
  • "login_id": "string",
  • "password": "string",
  • "first_name": "string",
  • "last_name": "string",
  • "email": "string",
  • "account": {
    },
  • "locale": "en_us"
}

Response samples

Content type
application/json
{
  • "stats": {
    },
  • "registration_user": {
    }
}

Given an invite code, provides a company it is associated with

On user registration, takes the invite code and returns the company it is associated with

Authorizations:
ApiKeyAuth
query Parameters
invitecode
required
string <string>

Invitation code

Responses

Response samples

Content type
application/json
{
  • "stats": {
    },
  • "registration_account": {
    }
}

Reviews

The Reviews API allows admins to perform document reviews for the workers

List of pending reviews

Admin API to get pending reviews

Authorizations:
ApiKeyAuth

Responses

Response samples

Content type
application/json
{
  • "stats": {
    },
  • "reviews": [
    ]
}

Get count of pending reviews

Returns count of pending reviews

Authorizations:
ApiKeyAuth

Responses

Response samples

Content type
application/json
{
  • "stats": {
    },
  • "reviews": {
    }
}

Review and edit a review

Allows an admin to review documents uploaded

Authorizations:
ApiKeyAuth
path Parameters
id
integer

references an id to reduce list down to 1 item

Responses

Response samples

Content type
application/json
{
  • "stats": {
    },
  • "reviews": {
    }
}

Add document to review

Allows an admin to upload a document to the review

Authorizations:
ApiKeyAuth
path Parameters
id
integer

references an id to reduce list down to 1 item

Responses

Response samples

Content type
application/json
{
  • "stats": {
    },
  • "reviews": { }
}

Remove document in review

Allows an admin to remove a document

Authorizations:
ApiKeyAuth
path Parameters
id
integer

references an id to reduce list down to 1 item

docid
required
integer

ID del documento a eliminar

Responses

Response samples

Content type
application/json
{
  • "stats": {
    },
  • "reviews": { }
}

Get count of documents uploaded

Returns how many documents have been submitted to the review

Authorizations:
ApiKeyAuth
path Parameters
id
integer

references an id to reduce list down to 1 item

Responses

Response samples

Content type
application/json
{
  • "stats": {
    },
  • "reviews": { }
}

Get count of documents uploaded and have been approved

Returns how many documents have been submitted to the review and admin has reviewed

Authorizations:
ApiKeyAuth
path Parameters
id
integer

references an id to reduce list down to 1 item

Responses

Response samples

Content type
application/json
{
  • "stats": {
    },
  • "reviews": { }
}

Mark upload as viewed

Marks a document as reviewed

Authorizations:
ApiKeyAuth
path Parameters
id
integer

references an id to reduce list down to 1 item

docid
required
integer

ID del documento a eliminar

Responses

Response samples

Content type
application/json
{
  • "stats": {
    },
  • "reviews": { }
}

Closes a review as accepted

Marks a review as reviewed

Authorizations:
ApiKeyAuth
path Parameters
id
integer

references an id to reduce list down to 1 item

Responses

Response samples

Content type
application/json
{
  • "stats": {
    },
  • "reviews": { }
}

Rejects a pending review and sends it back to the worker

Marks a review as rejected and puts back on worker to do list

Authorizations:
ApiKeyAuth
path Parameters
id
integer

references an id to reduce list down to 1 item

Responses

Response samples

Content type
application/json
{
  • "stats": {
    },
  • "reviews": { }
}

Roles

The Roles API allows you to retrieve role information.

List of roles

Returns a list of roles

Authorizations:
ApiKeyAuth
query Parameters
start
integer
Default: 1

Offset of the first record to return

limit
integer
Default: 3000

Maximum number of records to return

sort
string
Enum: "id" "code" "title" "group"

Name of field to sort by

search
string

Search term - check for the code and title

showAll
boolean
Default: false

Return all roles available, not only the ones configured

user
integer <int64>

Filter the results for a specify user id

site_id
integer <int64>

Filter for in-use assignments at a given site

Responses

Response samples

Content type
application/json
{
  • "stats": {
    },
  • "roles": [
    ]
}

Get role by id

Returns the information of the role with the given id

Authorizations:
ApiKeyAuth
path Parameters
rolID
required
integer <int64>

Filter for the given role id

query Parameters
start
integer
Default: 1

Offset of the first record to return

limit
integer
Default: 3000

Maximum number of records to return

sort
string
Enum: "id" "code" "title" "group"

Name of field to sort by

search
string

Search term - check for the code and title

showAll
boolean

Return all results available, not only the ones configured

Responses

Response samples

Content type
application/json
{
  • "stats": {
    },
  • "role": {
    }
}

Insert new role to user

Adds the given role to the given user

Authorizations:
ApiKeyAuth
path Parameters
rolID
required
integer <int64>

Filter for the given role id

usrID
required
integer <int64>

Filter for the given user id

Responses

Response samples

Content type
application/json
{
  • "stats": {
    },
  • "roles": {
    }
}

Delete the asignation of the role to the user

Delete the asignation of the role to the user id given

Authorizations:
ApiKeyAuth
path Parameters
rolID
required
integer <int64>

Filter for the given role id

usrID
required
integer <int64>

Filter for the given user id

Responses

Response samples

Content type
application/json
Example
{
  • "stats": {
    },
  • "roles": {
    }
}

Bulk role assignment or unassignment to users

Assign or unassign multiple roles to multiple users

Authorizations:
ApiKeyAuth
Request Body schema: application/json
required

JSON data with the list of roles to assign or unassign to users

Unassign
integer

Unassign or assign the roles

UsrID
required
Array of integers

List of user ids

RolID
required
Array of integers

List of role ids

Responses

Request samples

Content type
application/json
Example
{
  • "Unassign": 1,
  • "UsrID": [
    ],
  • "RolID": [
    ]
}

Response samples

Content type
application/json
Example
{
  • "stats": {
    },
  • "roles": {
    }
}

Sites

The Sites API allows you to retrieve site information.

Get Sites user has reporting permission over

Retrieve a list of sites the user can report on. Supports filtering, searching, and pagination. Can filter sites based on user assignments, connections status, and search criteria.

Authorizations:
ApiKeyAuth
query Parameters
start
integer
Default: 1

Offset of the first record to return

limit
integer
Default: 3000

Maximum number of records to return

sort
string
Enum: "id" "code" "title" "group"

Name of field to sort by

search
string

Search term - check for the code and title

path
string
Default: "down"
Enum: "down" "up" "branch"

Direction to traverse site hierarchy (down, up, branch)

user_id
integer

Filter sites that a specific user can be assigned to

connections
integer
Default: 0
Enum: 0 1

Include external connections

Responses

Response samples

Content type
application/json
[
  • {
    },
  • {
    }
]

Get Sites for User Management (Legacy) Deprecated

Legacy endpoint. Use /sites/assign instead. Retrieve sites available for user management operations. Requires user or supervisor worker permissions.

Authorizations:
ApiKeyAuth
query Parameters
start
integer
Default: 1

Offset of the first record to return

limit
integer
Default: 3000

Maximum number of records to return

sort
string
Enum: "id" "code" "title" "group"

Name of field to sort by

search
string

Search term - check for the code and title

path
string
Default: "down"
Enum: "down" "up" "branch"

Direction to traverse site hierarchy (down, up, branch)

user_id
integer

Filter sites that a specific user can be assigned to

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Assign User to Site

Assign a user to a specific site. Creates a site assignment relationship between the user and site with proper validation and permissions checking.

Authorizations:
ApiKeyAuth
path Parameters
id
required
integer

Site ID to assign user to

query Parameters
uid
required
integer

User ID to assign to the site

Responses

Response samples

Content type
application/json
{
  • "stats": {
    },
  • "sites": {
    }
}

Remove User from Site

Remove a user's assignment from a specific site. Deletes the site assignment relationship with proper validation and permissions checking.

Authorizations:
ApiKeyAuth
path Parameters
id
required
integer

Site ID to remove user from

query Parameters
uid
required
integer

User ID to remove from the site

Responses

Response samples

Content type
application/json
{
  • "code": 200,
  • "message": "User removed from site",
  • "detail": ""
}

Get Sites for Variance Management

Retrieve sites available for variance management operations. Requires variance management permissions.

Authorizations:
ApiKeyAuth
query Parameters
start
integer
Default: 1

Offset of the first record to return

limit
integer
Default: 3000

Maximum number of records to return

sort
string
Enum: "id" "code" "title" "group"

Name of field to sort by

search
string

Search term - check for the code and title

path
string
Default: "down"
Enum: "down" "up" "branch"

Direction to traverse site hierarchy (down, up, branch)

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get Site Variance Details

Retrieve variance management details for a specific site.

Authorizations:
ApiKeyAuth
path Parameters
id
required
integer

Site ID

Responses

Response samples

Content type
application/json
{
  • "id": 111,
  • "name": "Avetta Admin",
  • "con_id": "SITE001",
  • "top_id": 110,
  • "parent_id": 110
}

Get Sites for Self-Registration

Retrieve sites available for self-registration, allowing users to see which sites they can register themselves to. Self-registration must be enabled in company configuration.

Authorizations:
ApiKeyAuth
query Parameters
start
integer
Default: 1

Offset of the first record to return

limit
integer
Default: 3000

Maximum number of records to return

sort
string
Enum: "id" "code" "title" "group"

Name of field to sort by

search
string

Search term - check for the code and title

path
string
Default: "down"
Enum: "down" "up" "branch"

Direction to traverse site hierarchy (down, up, branch)

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get Site Registration Details

Retrieve registration details for a specific site. Self-registration must be enabled in company configuration.

Authorizations:
ApiKeyAuth
path Parameters
id
required
integer

Site ID

Responses

Response samples

Content type
application/json
{
  • "id": 111,
  • "name": "Avetta Admin",
  • "con_id": "SITE001",
  • "top_id": 110,
  • "parent_id": 110
}

Self-Register User to Site

Allow a user to register themselves to a site when permitted by site configuration. Self-registration must be enabled in company configuration.

Authorizations:
ApiKeyAuth
path Parameters
id
required
integer

Site ID to register to

Responses

Response samples

Content type
application/json
{
  • "code": 200,
  • "message": "User assigned to site",
  • "detail": ""
}

Self-Unregister User from Site

Allow a user to unregister themselves from a site. Self-registration must be enabled in company configuration.

Authorizations:
ApiKeyAuth
path Parameters
id
required
integer

Site ID to unregister from

Responses

Response samples

Content type
application/json
{
  • "code": 200,
  • "message": "User removed from site",
  • "detail": ""
}

Get Site by ID

Retrieve a specific site by its ID.

Authorizations:
ApiKeyAuth
path Parameters
grpID
required
integer

Site ID

query Parameters
path
string
Default: "down"
Enum: "down" "up" "branch"

Direction to traverse site hierarchy (down, up, branch)

connections
integer
Default: 0
Enum: 0 1

Include external connections

Responses

Response samples

Content type
application/json
{
  • "id": 111,
  • "name": "Avetta Admin",
  • "con_id": "SITE001",
  • "top_id": 110,
  • "parent_id": 110
}

Get Site Details for User Management

Retrieve details for a specific site in the context of user management.

Authorizations:
ApiKeyAuth
path Parameters
grpID
required
integer

Site ID

usrID
required
integer

User ID

query Parameters
user_id
integer

Filter for a specific user context

Responses

Response samples

Content type
application/json
{
  • "id": 111,
  • "name": "Avetta Admin",
  • "con_id": "SITE001",
  • "top_id": 110,
  • "parent_id": 110
}

TimeCard

The TimeCard API allows you to retrieve a list of workers on site.

List of usersworkers currently checked in but not checked out

The API will only return workers that are currently checked in but not checked out. Using the parameter site_id, workers checked in a specific site will be returned; if not provided, check-ins for all sites that the user has permissions for will be displayed. It's possible for a worker to be logged into more than one site at the same time; in this case, the same worker may appear more than one time in the timecard array.

Authorizations:
ApiKeyAuth
query Parameters
start
integer
Default: 1

Offset of the first record to return

limit
integer
Default: 3000

Maximum number of records to return

sort
string
Enum: "id" "code" "title" "group"

Name of field to sort by

site_id
integer

Filters information to a specific site and drilled down any site below it.

connection_id
integer

If specified, only information about a specific site would be displayed

account_id
integer

Filter workers that belong to the company id provided (This can be used to show only workers from a specific supplier)

role_id
integer

Filter down to a role id provided

search
string

Search term in users list - It checks the term in login id, email, first name, last name, mobile phone, company name and company site name.

flag
string
Enum: "G" "Green" "Y" "Yellow" "R" "Red"

filter by the worker's compliance flag to the site they are checked in. (G or Green, Y or Yellow, R or Red)

extra
string
Value: "photo"

Extra data to return for users (photo is the extra data that can included in the list of user)

Responses

Response samples

Content type
application/json
{
  • "stats": {
    },
  • "timecard": [
    ]
}

Count of users currently checked in but not checked out

Returns the count of workers currently checked in but not checked out. The count can be filtered by site.

Authorizations:
ApiKeyAuth
query Parameters
company_id
integer <int64>

Filter workers that belong to the company id provided (This can be used to show only workers from a specific supplier)

Responses

Response samples

Content type
application/json
{
  • "stats": {
    },
  • "timecard": {
    }
}

User

The User API allows you to retrieve user detail information.

User Details

Composite endpoint for user data

Authorizations:
ApiKeyAuth
path Parameters
id
integer
Example: 123

The ID of the user resource, if not provided, the results will corresponde to the current user

query Parameters
showAllConnections
integer <boolean>
Enum: 0 1

Show all connections for the user, even if there is no training associated

Responses

Response samples

Content type
application/json
{
  • "stats": {
    },
  • "user": {
    }
}

User Save

Save the user information in the profile form

Authorizations:
ApiKeyAuth
path Parameters
id
integer
Example: 123

The ID of the user resource, if not provided, the results will corresponde to the current user

Request Body schema: application/json
required

JSON data with the user information details - it could be a json object for one user or an array of objects for multiple users

UsrFirstName
string

First name

UsrMiddleInitial
string

Middle initial

UsrLastName
string

Last name

UsrTitleID
integer

Title ID

UsrEmailAddr
string

Email address

UsrEmploymentTypID
integer

Employment type ID

UsrAddrTypID
integer

Address type ID

UsrAddress1
string

Address line 1

UsrAddress2
string

Address line 2

UsrCity
string

City

UsrState
string

State

UsrZipCode
string

Zip code

UsrCountryID
integer

Country ID

UsrMobilePhone
string

Mobile phone

UsrHomePhone
string

Home phone

UsrWorkPhone
string

Work phone

UsrFaxPhone
string

Fax phone

UsrEmergencyContactName
string

Emergency contact name

UsrEmergencyContactPhone
string

Emergency contact phone

UsrEmergencyContactTypID
integer

Emergency contact type ID

UsrGenderTypID
integer

Gender type ID

UsrBirthDate
string

Birth date

UsrLegalWorkingAge
boolean
Enum: true false

Legal working age

UsrSSN
string

Protected field Social security number

Passport
string

Custom field sample

Responses

Request samples

Content type
application/json
{
  • "UsrFirstName": "John",
  • "UsrMiddleInitial": "A",
  • "UsrLastName": "Doe",
  • "UsrTitleID": 0,
  • "UsrEmailAddr": "john.doe@example.com",
  • "UsrEmploymentTypID": 1641,
  • "UsrAddrTypID": 61,
  • "UsrAddress1": "123 Main St",
  • "UsrAddress2": "Apt 4",
  • "UsrCity": "Anytown",
  • "UsrState": "Anystate",
  • "UsrZipCode": 12345,
  • "UsrCountryID": 10,
  • "UsrMobilePhone": "555-123-4567",
  • "UsrHomePhone": "555-987-6543",
  • "UsrWorkPhone": "555-555-5555",
  • "UsrFaxPhone": "555-666-7777",
  • "UsrEmergencyContactName": "Jane Doe",
  • "UsrEmergencyContactPhone": "555-111-2222",
  • "UsrEmergencyContactTypID": 1725,
  • "UsrGenderTypID": 161,
  • "UsrBirthDate": "1980-01-01",
  • "UsrLegalWorkingAge": true,
  • "UsrSSN": "123-45-6789",
  • "Passport": "AB1234567"
}

Response samples

Content type
application/json
{
  • "summary": "200 - Successful profile save example",
  • "value": {
    }
}

Profile Details

Profile form information

Authorizations:
ApiKeyAuth
path Parameters
id
integer
Example: 123

The ID of the user resource, if not provided, the results will corresponde to the current user

Responses

Response samples

Content type
application/json
{
  • "summary": "200 - Successful profile example",
  • "value": {
    }
}

Profile Save

Save the logged user information in the profile form

Authorizations:
ApiKeyAuth
path Parameters
id
integer
Example: 123

The ID of the user resource, if not provided, the results will corresponde to the current user

Request Body schema: application/json
required

JSON data with the user information details - it could be a json object for one user or an array of objects for multiple users

UsrFirstName
string

First name

UsrMiddleInitial
string

Middle initial

UsrLastName
string

Last name

UsrTitleID
integer

Title ID

UsrEmailAddr
string

Email address

UsrEmploymentTypID
integer

Employment type ID

UsrAddrTypID
integer

Address type ID

UsrAddress1
string

Address line 1

UsrAddress2
string

Address line 2

UsrCity
string

City

UsrState
string

State

UsrZipCode
string

Zip code

UsrCountryID
integer

Country ID

UsrMobilePhone
string

Mobile phone

UsrHomePhone
string

Home phone

UsrWorkPhone
string

Work phone

UsrFaxPhone
string

Fax phone

UsrEmergencyContactName
string

Emergency contact name

UsrEmergencyContactPhone
string

Emergency contact phone

UsrEmergencyContactTypID
integer

Emergency contact type ID

UsrGenderTypID
integer

Gender type ID

UsrBirthDate
string

Birth date

UsrLegalWorkingAge
boolean
Enum: true false

Legal working age

UsrSSN
string

Protected field Social security number

Passport
string

Custom field sample

Responses

Request samples

Content type
application/json
{
  • "UsrFirstName": "John",
  • "UsrMiddleInitial": "A",
  • "UsrLastName": "Doe",
  • "UsrTitleID": 0,
  • "UsrEmailAddr": "john.doe@example.com",
  • "UsrEmploymentTypID": 1641,
  • "UsrAddrTypID": 61,
  • "UsrAddress1": "123 Main St",
  • "UsrAddress2": "Apt 4",
  • "UsrCity": "Anytown",
  • "UsrState": "Anystate",
  • "UsrZipCode": 12345,
  • "UsrCountryID": 10,
  • "UsrMobilePhone": "555-123-4567",
  • "UsrHomePhone": "555-987-6543",
  • "UsrWorkPhone": "555-555-5555",
  • "UsrFaxPhone": "555-666-7777",
  • "UsrEmergencyContactName": "Jane Doe",
  • "UsrEmergencyContactPhone": "555-111-2222",
  • "UsrEmergencyContactTypID": 1725,
  • "UsrGenderTypID": 161,
  • "UsrBirthDate": "1980-01-01",
  • "UsrLegalWorkingAge": true,
  • "UsrSSN": "123-45-6789",
  • "Passport": "AB1234567"
}

Response samples

Content type
application/json
{
  • "summary": "200 - Successful profile save example",
  • "value": {
    }
}

User Photo

Get the user photo

Authorizations:
ApiKeyAuth
path Parameters
id
integer
Example: 123

The ID of the user resource, if not provided, the results will corresponde to the current user

Responses

Response samples

Content type
application/json
{
  • "stats": {
    },
  • "user": {
    }
}

User Photo Save

Save the user photo

Authorizations:
ApiKeyAuth
path Parameters
id
integer
Example: 123

The ID of the user resource, if not provided, the results will corresponde to the current user

Request Body schema: multipart/form-data
file
string <binary>

Responses

Response samples

Content type
application/json
{
  • "stats": {
    },
  • "user": {
    }
}

User Photo Delete

Delete the user photo

Authorizations:
ApiKeyAuth
path Parameters
id
integer
Example: 123

The ID of the user resource, if not provided, the results will corresponde to the current user

Responses

Response samples

Content type
application/json
{
  • "stats": {
    },
  • "user": {
    }
}

User List

Get List check in/out

Authorizations:
ApiKeyAuth
path Parameters
id
integer

references an id to reduce list down to 1 item

query Parameters
site
integer
Example: site=44

Site ID

Responses

Response samples

Content type
application/json
Example
{
  • "stats": {
    },
  • "user": {
    }
}

Check in

Check in

Authorizations:
ApiKeyAuth
path Parameters
id
integer

references an id to reduce list down to 1 item

query Parameters
site
integer
Example: site=44

Site ID

flag
string
Example: flag=Red

Flag

notes
string
Example: notes=Check in

Notes about the check in/out

time_in
required
string
Example: time_in=2021-09-01 08:00

Time in

Responses

Response samples

Content type
application/json
Example
{
  • "stats": {
    },
  • "user": {
    }
}

Check out

Check out

Authorizations:
ApiKeyAuth
path Parameters
id
integer

references an id to reduce list down to 1 item

query Parameters
site
integer
Example: site=44

Site ID

flag
string
Example: flag=Red

Flag

notes
string
Example: notes=Check in

Notes about the check in/out

time_out
required
string
Example: time_out=2021-09-01 17:00

Time out

Responses

Response samples

Content type
application/json
Example
{
  • "stats": {
    },
  • "user": {
    }
}

Check in status

Return the status of the check in for a user in a group

Authorizations:
ApiKeyAuth
path Parameters
id
integer

references an id to reduce list down to 1 item

grpID
required
integer
Example: 44

Site ID

Responses

Response samples

Content type
application/json
{
  • "stats": {
    },
  • "user": {
    }
}

Check in list sites

Return the list of sites where the user can check in

Authorizations:
ApiKeyAuth
path Parameters
id
integer

references an id to reduce list down to 1 item

Responses

Response samples

Content type
application/json
{
  • "stats": {
    },
  • "user": {
    }
}

History of check in/out

Return the history details of the check in and check out for a user

Authorizations:
ApiKeyAuth
path Parameters
id
integer

references an id to reduce list down to 1 item

query Parameters
site
integer
Example: site=44

Site ID

startDate
string
Example: startDate=2021-09-01 00:00

Filter by check in date where the given date is greater or equal to the given date

endDate
string
Example: endDate=2021-09-01 23:59

Filter by check in date where the given date is less or equal to the given date

sort
string
Enum: "name" "con_id" "checkin" "checkout"
Example: sort=checkin

Sort the results by the given field: name - site name, con_id - site code, checkin - date to check in, checkout - date to check out

limit
integer
Default: 3000

Maximum number of records to return

start
integer
Default: 1

Offset of the first record to return

Responses

Response samples

Content type
application/json
{
  • "stats": {
    },
  • "user": {
    }
}

Group Selector

Get the list of groups the user is available to select from

Authorizations:
ApiKeyAuth
query Parameters
start
integer
Default: 1

Offset of the first record to return

limit
integer
Default: 3000

Maximum number of records to return

search
string

Search by the title of the group

Responses

Response samples

Content type
application/json
{
  • "stats": {
    },
  • "sites": {
    }
}

Set Viewing Group

Set the viewing group for the user session

Authorizations:
ApiKeyAuth
Request Body schema: application/json
required

Group Selector payload

id
integer

Group ID to set as viewing group. Use 0 to clear viewing group. ( optional if con_id is provided )

con_id
integer

Group code to set as viewing group. Alternative to the id field. ( optional if id is provided )

Responses

Request samples

Content type
application/json
{
  • "id": 27,
  • "con_id": 235843
}

Response samples

Content type
application/json
{
  • "stats": {
    },
  • "data": {
    }
}

Group Selector by ID

Get the list of children groups of a specific group ID

Authorizations:
ApiKeyAuth
path Parameters
grp_id
required
integer <integer>

Group ID to get its children groups

query Parameters
start
integer
Default: 1

Offset of the first record to return

limit
integer
Default: 3000

Maximum number of records to return

Responses

Response samples

Content type
application/json
{
  • "stats": {
    },
  • "sites": {
    }
}

Users

The Users API allows you to retrieve all users information.

List of users

Returns a list of users that could be filtered by the given parameters

Authorizations:
ApiKeyAuth
path Parameters
id
integer

references an id to reduce list down to 1 item

query Parameters
start
integer
Default: 1

Offset of the first record to return

limit
integer
Default: 3000

Maximum number of records to return

sort
string
Enum: "id" "first_name" "last_name" "login_id" "email" "status" "flag" "created_date" "updated_date"

Name of field to sort by

search
string

Search term - It checks the term in login id, email, first name, last name, mobile phone, company name and company site name.

modifiedAfter
string <date-time>

Filter Only users modified or added after this date

flag
string
Enum: "Green" "Amber" "Red"

Filter the results for a specify rating (Green, Amber, Red)

search_type
integer
Value: 2010

Restrict the search value by comparing first name and last name only (value: 2010 or null)

extra
string
Enum: "photos" "permissions" "roles" "requirements" "connections" "history" "custom" "variances"

Extra data to return for users (Can be send as a list separated by commas)

role_id
integer

Filter down to a role

showInactive
integer <boolean>
Enum: 0 1

Show inactive users in the results

showRemoved
integer <boolean>
Enum: 0 1

Show removed users in the results

account_id
integer

Filter down from a group id where user belongs to

account_con_id
integer

Filter down form a group code where user belongs to

site_id
integer

Filter from a specific site id to drill down

allusers
integer <boolean>
Enum: 0 1

Return all users regardless if they have training

connection_id
integer

Filter by the connected site id to drill down

connection_con_id
integer

Filter by the connected site code to drill down

showAllConnections
integer <boolean>
Enum: 0 1

Show all connections for the user, even if there is no training associated

Responses

Response samples

Content type
application/json
Example
{
  • "id": 1235,
  • "con_id": 1568432,
  • "first_name": "John",
  • "last_name": "Doe",
  • "login_id": "jdoe",
  • "email": "test@test.com",
  • "dob": "1998-05-25",
  • "sap_id": 265813,
  • "cat_code": 1632,
  • "phone": 4561231159,
  • "status": "Active",
  • "flag": "Green",
  • "flag_forced": 0,
  • "title": "Director of Software Development",
  • "created_date": "2018-10-23 18:31:00",
  • "updated_date": "2017-15-05 16:41:00",
  • "last_checkin_date": "2020-10-23 15:00:00",
  • "last_checkout_date": "2020-10-23 19:45:00",
  • "badge_link": "",
  • "external_id": [
    ],
  • "removed": 0,
  • "emergency_phone": "555-555-5555",
  • "emergency_contact_name": "Bob Smith",
  • "emergency_contact_relationship": "Parent",
  • "account": {
    }
}

Insert or Update a user

Insert or update a user or a list of users

Authorizations:
ApiKeyAuth
path Parameters
id
integer

references an id to reduce list down to 1 item

Request Body schema: application/json
required

JSON data with the user information details - it could be a json object for one user or an array of objects for multiple users

Array
id
integer

User ID - if it exists it will update the user, if not it will create a new user

login_id
string

User login id - if is a new user it is required

first_name
string

User first name - if is a new user it is required

middle_initial
string

User middle initial

last_name
string

User last name - if is a new user it is required

password
string

User password - if is a new user it is required

site
string

Company site id - if is a new user it is required

email
string

User email

address1
string

User address line 1

address2
string

User address line 2

city
string

User city name

state
string

User state name

zipcode
string

User zipcode number

country
string

User country name - it could be the country id, code or the country name

mobile_phone
string

User mobile phone number - it should be in the international format

home_phone
string

User home phone number - it should be in the international format

work_phone
string

User work phone number - it should be in the international format

emergency_contact_name
string

User emergency contact name

emergency_contact_phone
string

User emergency contact phone number - it should be in the international format

birth_date
string

User birth date - it should be in the format YYYY-MM-DD

ssn
string

User social security number - it should be in the format XXX-XX-XXXX / XXXXXXXXX

photo
string

User photo - it should be in the format of a base64 string

hire_date
string

User hire date - it should be in the format YYYY-MM-DD

term_date
string

User termination date - it should be in the format YYYY-MM-DD

status
string
Enum: "active" "inactive"

User status - for new users it will be active

locale
string

User locale - it should be in the format of language-country - for new users it will be set as default if not provided

sap
string

User SAP id

notes
string

User notes

reset_password
boolean
Enum: true false

User reset password - if true it will check it to reset the user password

password_never_expired
boolean
Enum: true false

User password never expired - if true it will check it to set the user password as never expired

2fa
boolean
Enum: true false

User 2fa - if true it will check it to set the user as two factor authentication

Responses

Request samples

Content type
application/json
Example
{
  • "login_id": "jdoe",
  • "first_name": "John",
  • "middle_initial": "M",
  • "last_name": "Smith",
  • "password": "password!",
  • "site": 26516,
  • "email": "test@email.com",
  • "address1": "45 Main St",
  • "address2": "Apt 2",
  • "city": "New York",
  • "state": "NY",
  • "zipcode": 10001,
  • "country": "USA",
  • "mobile_phone": "+1 123456789",
  • "home_phone": "+1 123456789",
  • "work_phone": "+1 123456789",
  • "emergency_contact_name": "Bob Smith",
  • "emergency_contact_phone": "+1 123456789",
  • "birth_date": "1998-05-25",
  • "ssn": "123-45-6789",
  • "photo": "/9j/...",
  • "hire_date": "2020-10-23",
  • "term_date": "2024-10-23",
  • "status": "active",
  • "locale": "en-us",
  • "sap": 265813,
  • "notes": "User notes",
  • "reset_password": true,
  • "password_never_expired": false,
  • "2fa": false
}

Response samples

Content type
application/json
Example
{
  • "stats": {
    },
  • "users": {
    }
}

List of users fields

Returns a list of fields for creating a new user

Authorizations:
ApiKeyAuth

Responses

Response samples

Content type
application/json
Example
{
  • "stats": {
    },
  • "users": [
    ]
}

List of users fields by id

Returns a list of fields for a user by id for edit or update

Authorizations:
ApiKeyAuth
path Parameters
id
integer

references an id to reduce list down to 1 item

Responses

Response samples

Content type
application/json
Example
{
  • "stats": {
    },
  • "users": [
    ]
}

List of users (Credit)

Returns a list of users that could be credited for a requirement

Authorizations:
ApiKeyAuth
query Parameters
start
integer
Default: 1

Offset of the first record to return

limit
integer
Default: 3000

Maximum number of records to return

sort
string
Enum: "id" "first_name" "last_name" "login_id" "email" "status" "flag" "created_date" "updated_date"

Name of field to sort by

search
string

Search term - It checks the term in login id, email, first name, last name, mobile phone, company name and company site name.

modifiedAfter
string <date-time>

Filter Only users modified or added after this date

flag
string
Enum: "Green" "Amber" "Red"

Filter the results for a specify rating (Green, Amber, Red)

search_type
integer
Value: 2010

Restrict the search value by comparing first name and last name only (value: 2010 or null)

role_id
integer

Filter down to a role

showInactive
integer <boolean>
Enum: 0 1

Show inactive users in the results

showRemoved
integer <boolean>
Enum: 0 1

Show removed users in the results

account_id
integer

Filter down from a group id where user belongs to

account_con_id
integer

Filter down form a group code where user belongs to

site_id
integer

Filter from a specific site id to drill down

allusers
integer <boolean>
Enum: 0 1

Return all users regardless if they have training

connection_id
integer

Filter by the connected site id to drill down

connection_con_id
integer

Filter by the connected site code to drill down

event_id
integer

Show users that can be credited for the given requirement

Responses

Response samples

Content type
application/json
{
  • "id": 1235,
  • "con_id": 1568432,
  • "first_name": "John",
  • "last_name": "Doe",
  • "login_id": "jdoe",
  • "email": "test@test.com",
  • "dob": "1998-05-25",
  • "sap_id": 265813,
  • "cat_code": 1632,
  • "phone": 4561231159,
  • "status": "Active",
  • "flag": "Green",
  • "flag_forced": 0,
  • "title": "Director of Software Development",
  • "created_date": "2018-10-23 18:31:00",
  • "updated_date": "2017-15-05 16:41:00",
  • "last_checkin_date": "2020-10-23 15:00:00",
  • "last_checkout_date": "2020-10-23 19:45:00",
  • "badge_link": "",
  • "external_id": [
    ],
  • "removed": 0,
  • "emergency_phone": "555-555-5555",
  • "emergency_contact_name": "Bob Smith",
  • "emergency_contact_relationship": "Parent",
  • "account": {
    }
}

List of users (Manage)

Returns a list of users that can be managed

Authorizations:
ApiKeyAuth
query Parameters
start
integer
Default: 1

Offset of the first record to return

limit
integer
Default: 3000

Maximum number of records to return

sort
string
Enum: "id" "first_name" "last_name" "login_id" "email" "status" "flag" "created_date" "updated_date"

Name of field to sort by

search
string

Search term - It checks the term in login id, email, first name, last name, mobile phone, company name and company site name.

site_id
integer

Filter from a specific site id to drill down

account_id
integer

Filter down from a group id where user belongs to

connection_id
integer

Filter by the connected site id to drill down

flag
string
Enum: "Green" "Amber" "Red"

Filter the results for a specify rating (Green, Amber, Red)

role_id
integer

Filter down to a role

showInactive
integer <boolean>
Enum: 0 1

Show inactive users in the results

showRemoved
integer <boolean>
Enum: 0 1

Show removed users in the results

modifiedAfter
string <date-time>

Filter Only users modified or added after this date

Responses

Response samples

Content type
application/json
{
  • "id": 1235,
  • "con_id": 1568432,
  • "first_name": "John",
  • "last_name": "Doe",
  • "login_id": "jdoe",
  • "email": "test@test.com",
  • "dob": "1998-05-25",
  • "sap_id": 265813,
  • "cat_code": 1632,
  • "phone": 4561231159,
  • "status": "Active",
  • "flag": "Green",
  • "flag_forced": 0,
  • "title": "Director of Software Development",
  • "created_date": "2018-10-23 18:31:00",
  • "updated_date": "2017-15-05 16:41:00",
  • "last_checkin_date": "2020-10-23 15:00:00",
  • "last_checkout_date": "2020-10-23 19:45:00",
  • "badge_link": "",
  • "external_id": [
    ],
  • "removed": 0,
  • "emergency_phone": "555-555-5555",
  • "emergency_contact_name": "Bob Smith",
  • "emergency_contact_relationship": "Parent",
  • "account": {
    }
}

List of users (Manage by ID)

Returns a list of users that can be managed by ID

Authorizations:
ApiKeyAuth
path Parameters
id
integer

references an id to reduce list down to 1 item

Responses

Response samples

Content type
application/json
{
  • "id": 1235,
  • "con_id": 1568432,
  • "first_name": "John",
  • "last_name": "Doe",
  • "login_id": "jdoe",
  • "email": "test@test.com",
  • "dob": "1998-05-25",
  • "sap_id": 265813,
  • "cat_code": 1632,
  • "phone": 4561231159,
  • "status": "Active",
  • "flag": "Green",
  • "flag_forced": 0,
  • "title": "Director of Software Development",
  • "created_date": "2018-10-23 18:31:00",
  • "updated_date": "2017-15-05 16:41:00",
  • "last_checkin_date": "2020-10-23 15:00:00",
  • "last_checkout_date": "2020-10-23 19:45:00",
  • "badge_link": "",
  • "external_id": [
    ],
  • "removed": 0,
  • "emergency_phone": "555-555-5555",
  • "emergency_contact_name": "Bob Smith",
  • "emergency_contact_relationship": "Parent",
  • "account": {
    }
}

List of users (Variance)

Returns a list of users that can be given a variance

Authorizations:
ApiKeyAuth
query Parameters
start
integer
Default: 1

Offset of the first record to return

limit
integer
Default: 3000

Maximum number of records to return

sort
string
Enum: "id" "first_name" "last_name" "login_id" "email" "status" "flag" "created_date" "updated_date"

Name of field to sort by

search
string

Search term - It checks the term in login id, email, first name, last name, mobile phone, company name and company site name.

modifiedAfter
string <date-time>

Filter Only users modified or added after this date

flag
string
Enum: "Green" "Amber" "Red"

Filter the results for a specify rating (Green, Amber, Red)

search_type
integer
Value: 2010

Restrict the search value by comparing first name and last name only (value: 2010 or null)

role_id
integer

Filter down to a role

showInactive
integer <boolean>
Enum: 0 1

Show inactive users in the results

showRemoved
integer <boolean>
Enum: 0 1

Show removed users in the results

account_id
integer

Filter down from a group id where user belongs to

account_con_id
integer

Filter down form a group code where user belongs to

site_id
integer

Filter from a specific site id to drill down

allusers
integer <boolean>
Enum: 0 1

Return all users regardless if they have training

connection_id
integer

Filter by the connected site id to drill down

connection_con_id
integer

Filter by the connected site code to drill down

Responses

Response samples

Content type
application/json
{
  • "id": 1235,
  • "con_id": 1568432,
  • "first_name": "John",
  • "last_name": "Doe",
  • "login_id": "jdoe",
  • "email": "test@test.com",
  • "dob": "1998-05-25",
  • "sap_id": 265813,
  • "cat_code": 1632,
  • "phone": 4561231159,
  • "status": "Active",
  • "flag": "Green",
  • "flag_forced": 0,
  • "title": "Director of Software Development",
  • "created_date": "2018-10-23 18:31:00",
  • "updated_date": "2017-15-05 16:41:00",
  • "last_checkin_date": "2020-10-23 15:00:00",
  • "last_checkout_date": "2020-10-23 19:45:00",
  • "badge_link": "",
  • "external_id": [
    ],
  • "removed": 0,
  • "emergency_phone": "555-555-5555",
  • "emergency_contact_name": "Bob Smith",
  • "emergency_contact_relationship": "Parent",
  • "account": {
    }
}

Variances

The Variances API allows you to retrieve variance information or create a variance.

List of variances

Returns a list of variances that could be filtered by the given parameters

Authorizations:
ApiKeyAuth
query Parameters
start
integer
Default: 1

Offset of the first record to return

limit
integer
Default: 3000

Maximum number of records to return

sort
string
Enum: "id" "code" "title" "group"

Name of field to sort by

showAll
boolean

Return all results available, not only the ones configured

search
string

Search term - It checks the term in login id, email, first name, last name, mobile phone, company name and company site name.

type
integer
Enum: 2011 2012 2016

Filter down to only show role, site, requirement variances

account_id
integer

Filter down from a group id where user belongs to

status
string
Enum: "Green" "Amber" "Red"

Filter the results for a specify rating (Green, Amber, Red)

user_id
integer

Filter list of variances to ones assigned to the user

srch_id
integer

Return all users regardless if they have training

search_type
integer

Limit search to users fields only

role_id
integer

Role ID to filter results

site_id
integer

Site ID to filter results

Responses

Response samples

Content type
application/json
{
  • "stats": {
    },
  • "variances": [
    ]
}

Save a new variance

Save a new variance

Authorizations:
ApiKeyAuth
query Parameters
lng_id
integer

Language ID to return the strings in

doc_id
integer

Document ID to return the strings in

start
integer
Default: 1

Offset of the first record to return

limit
integer
Default: 3000

Maximum number of records to return

sort
string
Enum: "id" "code" "title" "group"

Name of field to sort by

search
string

Search term - It checks the term in login id, email, first name, last name, mobile phone, company name and company site name.

type
integer
Enum: 2011 2012 2016

Filter down to only show role, site, requirement variances

account_id
integer

Filter down from a group id where user belongs to

status
string
Enum: "Green" "Amber" "Red"

Filter the results for a specify rating (Green, Amber, Red)

user_id
integer

Filter list of variances to ones assigned to the user

showAll
boolean

Return all results available, not only the ones configured

srch_id
integer

Return all users regardless if they have training

search_type
integer

Limit search to users fields only

Request Body schema: multipart/form-data
required

Variance data to insert or update

VrnID
integer

Variance ID

VrnUsrID
integer

User ID

VrnGrpID
integer

Group ID

VrnStatusTypID
integer

Status Type ID

VrnRefTypID
integer

Reference Type ID

VrnRefID
integer

Reference ID

VrnBeginDateTime
string <date-time>

Begin Date Time

VrnEndDateTime
string <date-time>

End Date Time

VrnReason
string

Reason

Responses

Response samples

Content type
application/json
Example
{
  • "stats": {
    },
  • "variances": {
    }
}

List data for a variance

Returns the variance detail by the given id

Authorizations:
ApiKeyAuth
path Parameters
id
integer

references an id to reduce list down to 1 item

query Parameters
lng_id
integer

Language ID to return the strings in

doc_id
integer

Document ID to return the strings in

start
integer
Default: 1

Offset of the first record to return

limit
integer
Default: 3000

Maximum number of records to return

sort
string
Enum: "id" "code" "title" "group"

Name of field to sort by

search
string

Search term - It checks the term in login id, email, first name, last name, mobile phone, company name and company site name.

type
integer
Enum: 2011 2012 2016

Filter down to only show role, site, requirement variances

account_id
integer

Filter down from a group id where user belongs to

status
string
Enum: "Green" "Amber" "Red"

Filter the results for a specify rating (Green, Amber, Red)

user_id
integer

Filter list of variances to ones assigned to the user

showAll
boolean

Return all results available, not only the ones configured

srch_id
integer

Return all users regardless if they have training

search_type
integer

Limit search to users fields only

Responses

Response samples

Content type
application/json
{
  • "stats": {
    },
  • "variances": [
    ]
}

Save changes on a variance

Update the variance data with the data provided for the given id

Authorizations:
ApiKeyAuth
path Parameters
id
integer

references an id to reduce list down to 1 item

query Parameters
lng_id
integer

Language ID to return the strings in

doc_id
integer

Document ID to return the strings in

start
integer
Default: 1

Offset of the first record to return

limit
integer
Default: 3000

Maximum number of records to return

sort
string
Enum: "id" "code" "title" "group"

Name of field to sort by

search
string

Search term - It checks the term in login id, email, first name, last name, mobile phone, company name and company site name.

type
integer
Enum: 2011 2012 2016

Filter down to only show role, site, requirement variances

account_id
integer

Filter down from a group id where user belongs to

status
string
Enum: "Green" "Amber" "Red"

Filter the results for a specify rating (Green, Amber, Red)

user_id
integer

Filter list of variances to ones assigned to the user

showAll
boolean

Return all results available, not only the ones configured

Request Body schema: multipart/form-data
required

Variance data to insert or update

VrnID
integer

Variance ID

VrnUsrID
integer

User ID

VrnGrpID
integer

Group ID

VrnStatusTypID
integer

Status Type ID

VrnRefTypID
integer

Reference Type ID

VrnRefID
integer

Reference ID

VrnBeginDateTime
string <date-time>

Begin Date Time

VrnEndDateTime
string <date-time>

End Date Time

VrnReason
string

Reason

Responses

Response samples

Content type
application/json
Example
{
  • "stats": {
    },
  • "variances": {
    }
}

Count of variances

Returns the count of variances.

Authorizations:
ApiKeyAuth

Responses

Response samples

Content type
application/json
{
  • "stats": {
    },
  • "timecard": {
    }
}

List fields in variance - no Data

Returns a list of the fields in variances not related to any variance

Authorizations:
ApiKeyAuth
query Parameters
lng_id
integer

Language ID to return the strings in

search
string

Search term - It checks the term in login id, email, first name, last name, mobile phone, company name and company site name.

search_type
integer

Limit search to users fields only

account_id
integer

Filter down from a group id where user belongs to

type
integer
Enum: 2011 2012 2016

Filter down to only show role, site, requirement variances

user_id
integer

Filter list of variances to ones assigned to the user

status
string
Enum: "Green" "Amber" "Red"

Filter the results for a specify rating (Green, Amber, Red)

showAll
boolean

Return all results available, not only the ones configured

start
integer
Default: 1

Offset of the first record to return

limit
integer
Default: 3000

Maximum number of records to return

sort
string
Enum: "id" "code" "title" "group"

Name of field to sort by

Responses

Response samples

Content type
application/json
Example
{
  • "stats": {
    },
  • "fields": [
    ],
  • "files": [ ]
}

List fields with data for a variance

Returns a list of the fields in variances and the values for the given variance id

Authorizations:
ApiKeyAuth
path Parameters
id
integer

references an id to reduce list down to 1 item

query Parameters
search
string

Search term - It checks the term in login id, email, first name, last name, mobile phone, company name and company site name.

search_type
integer

Limit search to users fields only

account_id
integer

Filter down from a group id where user belongs to

type
integer
Enum: 2011 2012 2016

Filter down to only show role, site, requirement variances

user_id
integer

Filter list of variances to ones assigned to the user

status
string
Enum: "Green" "Amber" "Red"

Filter the results for a specify rating (Green, Amber, Red)

showAll
integer

Set to true if to show past variances also

start
integer
Default: 1

Offset of the first record to return

limit
integer
Default: 3000

Maximum number of records to return

sort
string
Enum: "id" "code" "title" "group"

Name of field to sort by

Responses

Response samples

Content type
application/json
Example
{
  • "stats": {
    },
  • "fields": [
    ],
  • "files": [ ]
}

Store temp file for a new variance

Store temp the given file for a new variance

Authorizations:
ApiKeyAuth
query Parameters
user_id
integer

Filter list of variances to ones assigned to the user

srch_id
integer

Return all users regardless if they have training

Request Body schema: multipart/form-data
required

File data to insert or delete for a variance

method
string
Value: "delete"

Method to use - used to pass a delete method

DocID
integer

Document ID to be deleted

DocFile
string <binary>

Upload the file to be uploaded or to be deleted as a file type of data

DocSecure
boolean
Enum: true false

Flag to indicate if the file is secure

Responses

Response samples

Content type
application/json
Example
{
  • "stats": {
    },
  • "variances": {
    }
}

Store temp file or delete for an existing variance

Store the given file for the variance given by id

Authorizations:
ApiKeyAuth
path Parameters
id
integer

references an id to reduce list down to 1 item

query Parameters
user_id
integer

Filter list of variances to ones assigned to the user

srch_id
integer

Return all users regardless if they have training

Request Body schema: multipart/form-data
required

File data to insert or delete for a variance

method
string
Value: "delete"

Method to use - used to pass a delete method

DocID
integer

Document ID to be deleted

DocFile
string <binary>

Upload the file to be uploaded or to be deleted as a file type of data

DocSecure
boolean
Enum: true false

Flag to indicate if the file is secure

Responses

Response samples

Content type
application/json
Example
{
  • "stats": {
    },
  • "variances": {
    }
}

Status

The Status API allows you to retrieve status information.

Status Connections

Get the number of users by status for each connection, filter by the parameters provided

Authorizations:
ApiKeyAuth
query Parameters
start
integer
Default: 1

Offset of the first record to return

limit
integer
Default: 3000

Maximum number of records to return

search
string

search string

flag
string

flag

rol_id
integer

role ID

site_id
integer

site ID

Responses

Response samples

Content type
application/json
{
  • "stats": {
    },
  • "status::Connections": {
    }
}

Status Connection by ID

Get the number of users by status for the connection id provided

Authorizations:
ApiKeyAuth
path Parameters
id
integer

references an id to reduce list down to 1 item

query Parameters
start
integer
Default: 1

Offset of the first record to return

limit
integer
Default: 3000

Maximum number of records to return

search
string

search string

flag
string

flag

rol_id
integer

role ID

site_id
integer

site ID

Responses

Response samples

Content type
application/json
{
  • "stats": {
    },
  • "status::Connections": {
    }
}

Status Roles

Get the number of users by status for each role, filter by the parameters provided

Authorizations:
ApiKeyAuth
query Parameters
start
integer
Default: 1

Offset of the first record to return

limit
integer
Default: 3000

Maximum number of records to return

search
string

search string

flag
string

flag

rol_id
integer

role ID

site_id
integer

site ID

account_id
integer

account ID

Responses

Response samples

Content type
application/json
{
  • "stats": {
    },
  • "status_roles": {
    }
}

Status Roles by ID

Get the number of users by status for the role id provided

Authorizations:
ApiKeyAuth
path Parameters
id
integer

references an id to reduce list down to 1 item

query Parameters
start
integer
Default: 1

Offset of the first record to return

limit
integer
Default: 3000

Maximum number of records to return

search
string

search string

flag
string

flag

rol_id
integer

role ID

site_id
integer

site ID

account_id
integer

account ID

Responses

Response samples

Content type
application/json
{
  • "stats": {
    },
  • "status_roles": {
    }
}

Status Sites

Get the number of users by status for each site, filter by the parameters provided

Authorizations:
ApiKeyAuth
query Parameters
start
integer
Default: 1

Offset of the first record to return

limit
integer
Default: 3000

Maximum number of records to return

search
string

search string

flag
string

flag

rol_id
integer

role ID

site_id
integer

site ID

account_id
integer

account ID

Responses

Response samples

Content type
application/json
{
  • "stats": {
    },
  • "status_roles": {
    }
}

Status Sites by ID

Get the number of users by status for the site id provided

Authorizations:
ApiKeyAuth
path Parameters
id
integer

references an id to reduce list down to 1 item

query Parameters
start
integer
Default: 1

Offset of the first record to return

limit
integer
Default: 3000

Maximum number of records to return

search
string

search string

flag
string

flag

rol_id
integer

role ID

site_id
integer

site ID

account_id
integer

account ID

Responses

Response samples

Content type
application/json
{
  • "stats": {
    },
  • "status_roles": {
    }
}

Status Users

Get a summary of the total users grouped by status filter by the parameters provided

Authorizations:
ApiKeyAuth
query Parameters
start
integer
Default: 1

Offset of the first record to return

limit
integer
Default: 3000

Maximum number of records to return

search
string

search string

flag
string

flag

rol_id
integer

role ID

site_id
integer

site ID

account_id
integer

account ID

Responses

Response samples

Content type
application/json
{
  • "stats": {
    },
  • "summary": [
    ]
}