• Users
  • getList users.
  • postUpsert user if the username or external ID matches.
  • getGet User.
  • putUpdate user.
  • postUpsert user if the username or external ID matches.
  • postCreates and/or updates Users from a List of Users.
  • putUpdate user management settings.
  • getGet currently authenticated User's details.
• Competencies
  • getLists the competencies for a user.

API docs by Redocly

Absorb Integration API (v1)

Download OpenAPI specification:Download

Users

List users.

Lists all selected LMS users that are available to the current, authenticated administrator.

Authorizations:

api_key

query Parameters

email	string (Deprecated) The specified email to filter by.
username	string (Deprecated) The specified username to filter by.
modifiedSince	string <date-time> (Deprecated) The specified date for filtering users that were edited after this date.
externalId	string (Deprecated) The specified external ID to filter by.
limit	string (Deprecated) The maximum number of items to return in the current page of the collection.
offset	string (Deprecated) The number of pages to offset into the collection.
_filter	string One or more filter operations to be performed on the collection. The referenced fields must allow filtering. See the respective report's schema for which fields can be filtered. Supports most of the OData filter syntax. Supported operations: * eq, * ne, * gt, * ge, * lt, * le, * and, * or, * not, * () Supported functions: * substringof('value',fieldName), * endswith(fieldName,'value'), * startswith(fieldName,'value'), * tolower(fieldName), * toupper(fieldName) Examples: _filter=firstname eq 'Jeffrey' _filter=id eq guid'a14c149a-2ce0-41d4-b532-02189ad3cb22' _filter=startsWith(lastname,'leb') or dateAdded ge datetime'1998-03-06T20:38:07Z'
_sort	string Optional list of comma-separated fields to sort the collection by. The referenced fields must allow sorting. See the respective report's schema for which fields can be sorted. If not specified, all report fields are returned. To sort in a descending manner, prefix the field name with -. For example, _sort=name,-date, sorts the collection of items by name (ascending) and then by date (descending).
_limit	string The maximum number of items to return in the current page of the collection.
_offset	string The number of pages to offset into the collection.

header Parameters

x-api-key	string
x-api-version	string 1

Responses

Response Schema: application/json

totalItems	integer <int32> The total number of items returned
limit	integer <int32> The page size.
offset	integer <int32> The page number.
returnedItems	integer <int32> The number of items returned.
	Array of objects (UserResource) The paged collection of resources.

US

https://rest.myabsorb.com/users

CA

https://rest.myabsorb.ca/users

EU

https://rest.myabsorb.eu/users

AU

https://rest.myabsorb.com.au/users

Response samples

• 200
• 422

Content type

application/json

{

• "totalItems": 0,
• "limit": 0,
• "offset": 0,
• "returnedItems": 0,
• "users": [

  • {

    • "id": "string",
    • "departmentId": "string",
    • "firstName": "string",
    • "middleName": "string",
    • "lastName": "string",
    • "username": "string",
    • "password": "string",
    • "emailAddress": "string",
    • "externalId": "string",
    • "ccEmailAddresses": [

      • "string"

      ],
    • "languageId": 0,
    • "gender": 0,
    • "address": "string",
    • "address2": "string",
    • "city": "string",
    • "provinceId": "string",
    • "countryId": "string",
    • "postalCode": "string",
    • "phone": "string",
    • "employeeNumber": "string",
    • "location": "string",
    • "jobTitle": "string",
    • "referenceNumber": "string",
    • "dateHired": "2019-08-24T14:15:22Z",
    • "dateTerminated": "2019-08-24T14:15:22Z",
    • "dateEdited": "2019-08-24T14:15:22Z",
    • "dateAdded": "2019-08-24T14:15:22Z",
    • "lastLoginDate": "2019-08-24T14:15:22Z",
    • "notes": "string",
    • "customFields": {

      • "decimal1": 0,
      • "decimal2": 0,
      • "decimal3": 0,
      • "decimal4": 0,
      • "decimal5": 0,
      • "string1": "string",
      • "string2": "string",
      • "string3": "string",
      • "string4": "string",
      • "string5": "string",
      • "string6": "string",
      • "string7": "string",
      • "string8": "string",
      • "string9": "string",
      • "string10": "string",
      • "string11": "string",
      • "string12": "string",
      • "string13": "string",
      • "string14": "string",
      • "string15": "string",
      • "string16": "string",
      • "string17": "string",
      • "string18": "string",
      • "string19": "string",
      • "string20": "string",
      • "string21": "string",
      • "string22": "string",
      • "string23": "string",
      • "string24": "string",
      • "string25": "string",
      • "string26": "string",
      • "string27": "string",
      • "string28": "string",
      • "string29": "string",
      • "string30": "string",
      • "datetime1": "2019-08-24T14:15:22Z",
      • "datetime2": "2019-08-24T14:15:22Z",
      • "datetime3": "2019-08-24T14:15:22Z",
      • "datetime4": "2019-08-24T14:15:22Z",
      • "datetime5": "2019-08-24T14:15:22Z",
      • "bool1": true,
      • "bool2": true,
      • "bool3": true,
      • "bool4": true,
      • "bool5": true

      },
    • "roleIds": [

      • "string"

      ],
    • "activeStatus": 0,
    • "isLearner": true,
    • "isAdmin": true,
    • "isInstructor": true,
    • "isManager": true,
    • "supervisorId": "string",
    • "hasUsername": true

    }

  ]

}

Upsert user if the username or external ID matches.

Authorizations:

api_key

query Parameters

key	integer Enum: 0 1 The identifier used to locate the user. Possible Enum Values: 0 = Username 1 = ExternalId

header Parameters

x-api-key	string
x-api-version	string 1

Request Body schema: application/json

The request body specifying the properties to update.

username required	string [ 0 .. 255 ] characters The user's username.
password	string [ 0 .. 255 ] characters The user's password.
departmentId required	string <guid> non-empty The user's department ID.
firstName required	string [ 0 .. 255 ] characters The user's first name.
lastName required	string [ 0 .. 255 ] characters The user's last name.
middleName	string [ 0 .. 255 ] characters The user's middle name.
address	string [ 0 .. 4000 ] characters The user's address.
address2	string [ 0 .. 4000 ] characters The user's second address.
city	string [ 0 .. 255 ] characters The user's city.
postalCode	string [ 0 .. 255 ] characters The user's postal code.
provinceId	string <guid> The user's province ID.
countryId	string <guid> The user's country ID.
location	string [ 0 .. 255 ] characters The user's location
dateHired	string <date-time> The date the user was hired.
dateTerminated	string <date-time> The date the user was terminated.
emailAddress	string [ 0 .. 255 ] characters ^[a-zA-Z0-9!#$%&'*+\/=?^_`{|}~-]+(\.[a-zA-Z0-... The user's email address.
ccEmailAddresses	Array of strings The user's cc email addresses.
employeeNumber	string [ 0 .. 255 ] characters The user's employee number.
supervisorId	string <guid> The user's supervisor's ID.
externalId	string [ 0 .. 255 ] characters The user's external ID.
languageId	integer <int32> The user's default language ID.
gender	integer Enum: 0 1 2 The user's gender. Possible Enum Values: 0 = None 1 = Male 2 = Female
activeStatus	integer Enum: 0 1 The user's active status. Possible Enum Values: 0 = Active 1 = Inactive
jobTitle	string [ 0 .. 255 ] characters The user's job title.
notes	string Notes about the user.
phone	string [ 0 .. 255 ] characters The user's phone number.
referenceNumber	string [ 0 .. 255 ] characters The user's reference number.
roleIds	Array of strings <guid> [ items <guid > ] The user's associated role IDs.
isLearner	boolean True if the user is a learner, otherwise false.
isInstructor	boolean True if the user is an instructor, otherwise false.
isAdmin	boolean True if the user is an admin, otherwise false.
hasUsername	boolean True if the user has a username, otherwise false.
	object The user's custom fields.

Responses

Response Schema: application/json

id	string <guid> The user's ID.
username	string [ 0 .. 255 ] characters The user's username.

Response Schema: application/json

id	string <guid> The user's ID.
username	string [ 0 .. 255 ] characters The user's username.

US

https://rest.myabsorb.com/users

CA

https://rest.myabsorb.ca/users

EU

https://rest.myabsorb.eu/users

AU

https://rest.myabsorb.com.au/users

Request samples

• Payload

Content type

application/json

{

• "username": "string",
• "password": "string",
• "departmentId": "string",
• "firstName": "string",
• "lastName": "string",
• "middleName": "string",
• "address": "string",
• "address2": "string",
• "city": "string",
• "postalCode": "string",
• "provinceId": "string",
• "countryId": "string",
• "location": "string",
• "dateHired": "2019-08-24T14:15:22Z",
• "dateTerminated": "2019-08-24T14:15:22Z",
• "emailAddress": "string",
• "ccEmailAddresses": [

  • "string"

  ],
• "employeeNumber": "string",
• "supervisorId": "string",
• "externalId": "string",
• "languageId": 0,
• "gender": 0,
• "activeStatus": 0,
• "jobTitle": "string",
• "notes": "string",
• "phone": "string",
• "referenceNumber": "string",
• "roleIds": [

  • "string"

  ],
• "isLearner": true,
• "isInstructor": true,
• "isAdmin": true,
• "hasUsername": true,
• "customFields": {

  • "decimal1": 0,
  • "decimal2": 0,
  • "decimal3": 0,
  • "decimal4": 0,
  • "decimal5": 0,
  • "string1": "string",
  • "string2": "string",
  • "string3": "string",
  • "string4": "string",
  • "string5": "string",
  • "string6": "string",
  • "string7": "string",
  • "string8": "string",
  • "string9": "string",
  • "string10": "string",
  • "string11": "string",
  • "string12": "string",
  • "string13": "string",
  • "string14": "string",
  • "string15": "string",
  • "string16": "string",
  • "string17": "string",
  • "string18": "string",
  • "string19": "string",
  • "string20": "string",
  • "string21": "string",
  • "string22": "string",
  • "string23": "string",
  • "string24": "string",
  • "string25": "string",
  • "string26": "string",
  • "string27": "string",
  • "string28": "string",
  • "string29": "string",
  • "string30": "string",
  • "datetime1": "2019-08-24T14:15:22Z",
  • "datetime2": "2019-08-24T14:15:22Z",
  • "datetime3": "2019-08-24T14:15:22Z",
  • "datetime4": "2019-08-24T14:15:22Z",
  • "datetime5": "2019-08-24T14:15:22Z",
  • "bool1": true,
  • "bool2": true,
  • "bool3": true,
  • "bool4": true,
  • "bool5": true

  }

}

Response samples

• 200
• 201
• 400
• 404
• 422

Content type

application/json

{

• "id": "string",
• "username": "string"

}

Get User.

Authorizations:

api_key

path Parameters

userId required

string <guid> The user ID.

header Parameters

x-api-key	string
x-api-version	string 1

Responses

Response Schema: application/json

id	string <guid> The unique user identifier.
departmentId	string <guid> The user's department ID.
firstName	string The first name.
middleName	string The middle name.
lastName	string The last name.
username	string The unique username.
password	string [ 0 .. 255 ] characters Password Required for User Creation.
emailAddress	string The user contact email address.
externalId	string The external ID used for integrations with external systems.
ccEmailAddresses	Array of strings List of email addresses, maximum 5 (MaxCcEmailSize)
languageId	integer <int32> The language id.
gender	integer Enum: 0 1 2 The gender. Possible Enum Values: 0 = None 1 = Male 2 = Female
address	string The mailing address.
address2	string The mailing address, part two.
city	string The city.
provinceId	string <guid> The province id.
countryId	string <guid> The country id.
postalCode	string The postal/zip code.
phone	string The phone number.
employeeNumber	string The employee number.
location	string The location.
jobTitle	string The job title.
referenceNumber	string The reference number.
dateHired	string <date-time> If applicable, the date the user was hired.
dateTerminated	string <date-time> If applicable, the date the user's employment was terminated.
dateEdited	string <date-time> The date the user is edited.
dateAdded	string <date-time> The date the user was added.
lastLoginDate	string <date-time> The last date the user successfully logged in.
notes	string The notes.
	object The custom fields.
roleIds	Array of strings <guid> [ items <guid > ] The role ids.
activeStatus	integer Enum: 0 1 The user's active status as UserActiveStatus . Possible Enum Values: 0 = Active 1 = Inactive
isLearner	boolean True if the user is a learner, otherwise false.
isAdmin	boolean True if the user is an administrator, otherwise false.
isInstructor	boolean True if the user is an instructor, otherwise false.
isManager	boolean True if the user is a manager, otherwise false.
supervisorId	string <guid> The supervisor id.
hasUsername	boolean Determines whether the user has a username or not.

US

https://rest.myabsorb.com/users/{userId}

CA

https://rest.myabsorb.ca/users/{userId}

EU

https://rest.myabsorb.eu/users/{userId}

AU

https://rest.myabsorb.com.au/users/{userId}

Response samples

• 200
• 404

Content type

application/json

{

• "id": "string",
• "departmentId": "string",
• "firstName": "string",
• "middleName": "string",
• "lastName": "string",
• "username": "string",
• "password": "string",
• "emailAddress": "string",
• "externalId": "string",
• "ccEmailAddresses": [

  • "string"

  ],
• "languageId": 0,
• "gender": 0,
• "address": "string",
• "address2": "string",
• "city": "string",
• "provinceId": "string",
• "countryId": "string",
• "postalCode": "string",
• "phone": "string",
• "employeeNumber": "string",
• "location": "string",
• "jobTitle": "string",
• "referenceNumber": "string",
• "dateHired": "2019-08-24T14:15:22Z",
• "dateTerminated": "2019-08-24T14:15:22Z",
• "dateEdited": "2019-08-24T14:15:22Z",
• "dateAdded": "2019-08-24T14:15:22Z",
• "lastLoginDate": "2019-08-24T14:15:22Z",
• "notes": "string",
• "customFields": {

  • "decimal1": 0,
  • "decimal2": 0,
  • "decimal3": 0,
  • "decimal4": 0,
  • "decimal5": 0,
  • "string1": "string",
  • "string2": "string",
  • "string3": "string",
  • "string4": "string",
  • "string5": "string",
  • "string6": "string",
  • "string7": "string",
  • "string8": "string",
  • "string9": "string",
  • "string10": "string",
  • "string11": "string",
  • "string12": "string",
  • "string13": "string",
  • "string14": "string",
  • "string15": "string",
  • "string16": "string",
  • "string17": "string",
  • "string18": "string",
  • "string19": "string",
  • "string20": "string",
  • "string21": "string",
  • "string22": "string",
  • "string23": "string",
  • "string24": "string",
  • "string25": "string",
  • "string26": "string",
  • "string27": "string",
  • "string28": "string",
  • "string29": "string",
  • "string30": "string",
  • "datetime1": "2019-08-24T14:15:22Z",
  • "datetime2": "2019-08-24T14:15:22Z",
  • "datetime3": "2019-08-24T14:15:22Z",
  • "datetime4": "2019-08-24T14:15:22Z",
  • "datetime5": "2019-08-24T14:15:22Z",
  • "bool1": true,
  • "bool2": true,
  • "bool3": true,
  • "bool4": true,
  • "bool5": true

  },
• "roleIds": [

  • "string"

  ],
• "activeStatus": 0,
• "isLearner": true,
• "isAdmin": true,
• "isInstructor": true,
• "isManager": true,
• "supervisorId": "string",
• "hasUsername": true

}

Update user.

Authorizations:

api_key

path Parameters

userId required

string <guid> The user ID.

header Parameters

x-api-key	string
x-api-version	string 1

Request Body schema: application/json

The request body to update a user.

username required	string [ 0 .. 255 ] characters The user's username.
password	string [ 0 .. 255 ] characters The user's password.
departmentId required	string <guid> non-empty The user's department ID.
firstName required	string [ 0 .. 255 ] characters The user's first name.
lastName required	string [ 0 .. 255 ] characters The user's last name.
middleName	string [ 0 .. 255 ] characters The user's middle name.
address	string [ 0 .. 4000 ] characters The user's address.
address2	string [ 0 .. 4000 ] characters The user's second address.
city	string [ 0 .. 255 ] characters The user's city.
postalCode	string [ 0 .. 255 ] characters The user's postal code.
provinceId	string <guid> The user's province ID.
countryId	string <guid> The user's country ID.
location	string [ 0 .. 255 ] characters The user's location
dateHired	string <date-time> The date the user was hired.
dateTerminated	string <date-time> The date the user was terminated.
emailAddress	string [ 0 .. 255 ] characters ^[a-zA-Z0-9!#$%&'*+\/=?^_`{|}~-]+(\.[a-zA-Z0-... The user's email address.
ccEmailAddresses	Array of strings The user's cc email addresses.
employeeNumber	string [ 0 .. 255 ] characters The user's employee number.
supervisorId	string <guid> The user's supervisor's ID.
externalId	string [ 0 .. 255 ] characters The user's external ID.
languageId	integer <int32> The user's default language ID.
gender	integer Enum: 0 1 2 The user's gender. Possible Enum Values: 0 = None 1 = Male 2 = Female
activeStatus	integer Enum: 0 1 The user's active status. Possible Enum Values: 0 = Active 1 = Inactive
jobTitle	string [ 0 .. 255 ] characters The user's job title.
notes	string Notes about the user.
phone	string [ 0 .. 255 ] characters The user's phone number.
referenceNumber	string [ 0 .. 255 ] characters The user's reference number.
roleIds	Array of strings <guid> [ items <guid > ] The user's associated role IDs.
isLearner	boolean True if the user is a learner, otherwise false.
isInstructor	boolean True if the user is an instructor, otherwise false.
isAdmin	boolean True if the user is an admin, otherwise false.
hasUsername	boolean True if the user has a username, otherwise false.
	object The user's custom fields.

Responses

Response Schema: application/json

id	string <guid> Filterable The unique user identifier.
departmentId	string <guid> Sortable Filterable The user's department ID.
firstName	string Sortable Filterable The first name.
middleName	string Sortable Filterable The middle name.
lastName	string Sortable Filterable The last name.
username	string Default Sort Sortable Filterable The unique username.
password	string [ 0 .. 255 ] characters Password Required for User Creation.
emailAddress	string Sortable Filterable The user contact email address.
externalId	string Sortable Filterable The external ID used for integrations with external systems.
ccEmailAddresses	Array of strings Filterable List of email addresses, maximum 5 (MaxCcEmailSize)
languageId	integer <int32> Sortable Filterable The language id.
gender	integer Enum: 0 1 2 Sortable Filterable The gender. Possible Enum Values: 0 = None 1 = Male 2 = Female
address	string Sortable Filterable The mailing address.
address2	string Sortable Filterable The mailing address, part two.
city	string Sortable Filterable The city.
provinceId	string <guid> Sortable Filterable The province id.
countryId	string <guid> Sortable Filterable The country id.
postalCode	string Sortable Filterable The postal/zip code.
phone	string Sortable Filterable The phone number.
employeeNumber	string Sortable Filterable The employee number.
location	string Sortable Filterable The location.
jobTitle	string Sortable Filterable The job title.
referenceNumber	string Sortable Filterable The reference number.
dateHired	string <date-time> Sortable Filterable If applicable, the date the user was hired.
dateTerminated	string <date-time> Sortable Filterable If applicable, the date the user's employment was terminated.
dateEdited	string <date-time> Sortable Filterable The date the user is edited.
dateAdded	string <date-time> Sortable Filterable The date the user was added.
lastLoginDate	string <date-time> Sortable Filterable The last date the user successfully logged in.
notes	string Filterable The notes.
	object Sortable Filterable The custom fields.
roleIds	Array of strings <guid> [ items <guid > ] Filterable The role ids.
activeStatus	integer Enum: 0 1 Sortable Filterable The user's active status as UserActiveStatus . Possible Enum Values: 0 = Active 1 = Inactive
isLearner	boolean Sortable Filterable True if the user is a learner, otherwise false.
isAdmin	boolean Sortable Filterable True if the user is an administrator, otherwise false.
isInstructor	boolean Sortable Filterable True if the user is an instructor, otherwise false.
isManager	boolean Sortable Filterable True if the user is a manager, otherwise false.
supervisorId	string <guid> Sortable Filterable The supervisor id.
hasUsername	boolean Determines whether the user has a username or not.

US

https://rest.myabsorb.com/users/{userId}

CA

https://rest.myabsorb.ca/users/{userId}

EU

https://rest.myabsorb.eu/users/{userId}

AU

https://rest.myabsorb.com.au/users/{userId}

Request samples

• Payload

Content type

application/json

{

• "username": "string",
• "password": "string",
• "departmentId": "string",
• "firstName": "string",
• "lastName": "string",
• "middleName": "string",
• "address": "string",
• "address2": "string",
• "city": "string",
• "postalCode": "string",
• "provinceId": "string",
• "countryId": "string",
• "location": "string",
• "dateHired": "2019-08-24T14:15:22Z",
• "dateTerminated": "2019-08-24T14:15:22Z",
• "emailAddress": "string",
• "ccEmailAddresses": [

  • "string"

  ],
• "employeeNumber": "string",
• "supervisorId": "string",
• "externalId": "string",
• "languageId": 0,
• "gender": 0,
• "activeStatus": 0,
• "jobTitle": "string",
• "notes": "string",
• "phone": "string",
• "referenceNumber": "string",
• "roleIds": [

  • "string"

  ],
• "isLearner": true,
• "isInstructor": true,
• "isAdmin": true,
• "hasUsername": true,
• "customFields": {

  • "decimal1": 0,
  • "decimal2": 0,
  • "decimal3": 0,
  • "decimal4": 0,
  • "decimal5": 0,
  • "string1": "string",
  • "string2": "string",
  • "string3": "string",
  • "string4": "string",
  • "string5": "string",
  • "string6": "string",
  • "string7": "string",
  • "string8": "string",
  • "string9": "string",
  • "string10": "string",
  • "string11": "string",
  • "string12": "string",
  • "string13": "string",
  • "string14": "string",
  • "string15": "string",
  • "string16": "string",
  • "string17": "string",
  • "string18": "string",
  • "string19": "string",
  • "string20": "string",
  • "string21": "string",
  • "string22": "string",
  • "string23": "string",
  • "string24": "string",
  • "string25": "string",
  • "string26": "string",
  • "string27": "string",
  • "string28": "string",
  • "string29": "string",
  • "string30": "string",
  • "datetime1": "2019-08-24T14:15:22Z",
  • "datetime2": "2019-08-24T14:15:22Z",
  • "datetime3": "2019-08-24T14:15:22Z",
  • "datetime4": "2019-08-24T14:15:22Z",
  • "datetime5": "2019-08-24T14:15:22Z",
  • "bool1": true,
  • "bool2": true,
  • "bool3": true,
  • "bool4": true,
  • "bool5": true

  }

}

Response samples

• 201
• 404
• 422

Content type

application/json

{

• "id": "string",
• "departmentId": "string",
• "firstName": "string",
• "middleName": "string",
• "lastName": "string",
• "username": "string",
• "password": "string",
• "emailAddress": "string",
• "externalId": "string",
• "ccEmailAddresses": [

  • "string"

  ],
• "languageId": 0,
• "gender": 0,
• "address": "string",
• "address2": "string",
• "city": "string",
• "provinceId": "string",
• "countryId": "string",
• "postalCode": "string",
• "phone": "string",
• "employeeNumber": "string",
• "location": "string",
• "jobTitle": "string",
• "referenceNumber": "string",
• "dateHired": "2019-08-24T14:15:22Z",
• "dateTerminated": "2019-08-24T14:15:22Z",
• "dateEdited": "2019-08-24T14:15:22Z",
• "dateAdded": "2019-08-24T14:15:22Z",
• "lastLoginDate": "2019-08-24T14:15:22Z",
• "notes": "string",
• "customFields": {

  • "decimal1": 0,
  • "decimal2": 0,
  • "decimal3": 0,
  • "decimal4": 0,
  • "decimal5": 0,
  • "string1": "string",
  • "string2": "string",
  • "string3": "string",
  • "string4": "string",
  • "string5": "string",
  • "string6": "string",
  • "string7": "string",
  • "string8": "string",
  • "string9": "string",
  • "string10": "string",
  • "string11": "string",
  • "string12": "string",
  • "string13": "string",
  • "string14": "string",
  • "string15": "string",
  • "string16": "string",
  • "string17": "string",
  • "string18": "string",
  • "string19": "string",
  • "string20": "string",
  • "string21": "string",
  • "string22": "string",
  • "string23": "string",
  • "string24": "string",
  • "string25": "string",
  • "string26": "string",
  • "string27": "string",
  • "string28": "string",
  • "string29": "string",
  • "string30": "string",
  • "datetime1": "2019-08-24T14:15:22Z",
  • "datetime2": "2019-08-24T14:15:22Z",
  • "datetime3": "2019-08-24T14:15:22Z",
  • "datetime4": "2019-08-24T14:15:22Z",
  • "datetime5": "2019-08-24T14:15:22Z",
  • "bool1": true,
  • "bool2": true,
  • "bool3": true,
  • "bool4": true,
  • "bool5": true

  },
• "roleIds": [

  • "string"

  ],
• "activeStatus": 0,
• "isLearner": true,
• "isAdmin": true,
• "isInstructor": true,
• "isManager": true,
• "supervisorId": "string",
• "hasUsername": true

}

Upsert user if the username or external ID matches.

Authorizations:

api_key

query Parameters

key	integer Enum: 0 1 The identifier used to locate the user. Possible Enum Values: 0 = Username 1 = ExternalId

header Parameters

x-api-key	string
x-api-version	string 1

Request Body schema: application/json

The request body specifying the properties to update.

username required	string [ 0 .. 255 ] characters The user's username.
password	string [ 0 .. 255 ] characters The user's password.
departmentId required	string <guid> non-empty The user's department ID.
firstName required	string [ 0 .. 255 ] characters The user's first name.
lastName required	string [ 0 .. 255 ] characters The user's last name.
middleName	string [ 0 .. 255 ] characters The user's middle name.
address	string [ 0 .. 4000 ] characters The user's address.
address2	string [ 0 .. 4000 ] characters The user's second address.
city	string [ 0 .. 255 ] characters The user's city.
postalCode	string [ 0 .. 255 ] characters The user's postal code.
provinceId	string <guid> The user's province ID.
countryId	string <guid> The user's country ID.
location	string [ 0 .. 255 ] characters The user's location
dateHired	string <date-time> The date the user was hired.
dateTerminated	string <date-time> The date the user was terminated.
emailAddress	string [ 0 .. 255 ] characters ^[a-zA-Z0-9!#$%&'*+\/=?^_`{|}~-]+(\.[a-zA-Z0-... The user's email address.
ccEmailAddresses	Array of strings The user's cc email addresses.
employeeNumber	string [ 0 .. 255 ] characters The user's employee number.
supervisorId	string <guid> The user's supervisor's ID.
externalId	string [ 0 .. 255 ] characters The user's external ID.
languageId	integer <int32> The user's default language ID.
gender	integer Enum: 0 1 2 The user's gender. Possible Enum Values: 0 = None 1 = Male 2 = Female
activeStatus	integer Enum: 0 1 The user's active status. Possible Enum Values: 0 = Active 1 = Inactive
jobTitle	string [ 0 .. 255 ] characters The user's job title.
notes	string Notes about the user.
phone	string [ 0 .. 255 ] characters The user's phone number.
referenceNumber	string [ 0 .. 255 ] characters The user's reference number.
roleIds	Array of strings <guid> [ items <guid > ] The user's associated role IDs.
isLearner	boolean True if the user is a learner, otherwise false.
isInstructor	boolean True if the user is an instructor, otherwise false.
isAdmin	boolean True if the user is an admin, otherwise false.
hasUsername	boolean True if the user has a username, otherwise false.
	object The user's custom fields.

Responses

Response Schema: application/json

id	string <guid> The user's ID.
username	string [ 0 .. 255 ] characters The user's username.

Response Schema: application/json

id	string <guid> The user's ID.
username	string [ 0 .. 255 ] characters The user's username.

US

https://rest.myabsorb.com/create-absorb-account

CA

https://rest.myabsorb.ca/create-absorb-account

EU

https://rest.myabsorb.eu/create-absorb-account

AU

https://rest.myabsorb.com.au/create-absorb-account

Request samples

• Payload

Content type

application/json

{

• "username": "string",
• "password": "string",
• "departmentId": "string",
• "firstName": "string",
• "lastName": "string",
• "middleName": "string",
• "address": "string",
• "address2": "string",
• "city": "string",
• "postalCode": "string",
• "provinceId": "string",
• "countryId": "string",
• "location": "string",
• "dateHired": "2019-08-24T14:15:22Z",
• "dateTerminated": "2019-08-24T14:15:22Z",
• "emailAddress": "string",
• "ccEmailAddresses": [

  • "string"

  ],
• "employeeNumber": "string",
• "supervisorId": "string",
• "externalId": "string",
• "languageId": 0,
• "gender": 0,
• "activeStatus": 0,
• "jobTitle": "string",
• "notes": "string",
• "phone": "string",
• "referenceNumber": "string",
• "roleIds": [

  • "string"

  ],
• "isLearner": true,
• "isInstructor": true,
• "isAdmin": true,
• "hasUsername": true,
• "customFields": {

  • "decimal1": 0,
  • "decimal2": 0,
  • "decimal3": 0,
  • "decimal4": 0,
  • "decimal5": 0,
  • "string1": "string",
  • "string2": "string",
  • "string3": "string",
  • "string4": "string",
  • "string5": "string",
  • "string6": "string",
  • "string7": "string",
  • "string8": "string",
  • "string9": "string",
  • "string10": "string",
  • "string11": "string",
  • "string12": "string",
  • "string13": "string",
  • "string14": "string",
  • "string15": "string",
  • "string16": "string",
  • "string17": "string",
  • "string18": "string",
  • "string19": "string",
  • "string20": "string",
  • "string21": "string",
  • "string22": "string",
  • "string23": "string",
  • "string24": "string",
  • "string25": "string",
  • "string26": "string",
  • "string27": "string",
  • "string28": "string",
  • "string29": "string",
  • "string30": "string",
  • "datetime1": "2019-08-24T14:15:22Z",
  • "datetime2": "2019-08-24T14:15:22Z",
  • "datetime3": "2019-08-24T14:15:22Z",
  • "datetime4": "2019-08-24T14:15:22Z",
  • "datetime5": "2019-08-24T14:15:22Z",
  • "bool1": true,
  • "bool2": true,
  • "bool3": true,
  • "bool4": true,
  • "bool5": true

  }

}

Response samples

• 200
• 201
• 400
• 404
• 422

Content type

application/json

{

• "id": "string",
• "username": "string"

}

Creates and/or updates Users from a List of Users.

A maximum of 200 users can be uploaded per request.

Authorizations:

api_key

query Parameters

key	integer Enum: 0 1 The identifier used to locate the user. Possible Enum Values: 0 = Username 1 = ExternalId

header Parameters

x-api-key	string
x-api-version	string 1

Request Body schema: application/json

The request body which lists users.

Array

username required	string [ 0 .. 255 ] characters The user's username.
password	string [ 0 .. 255 ] characters The user's password.
departmentId required	string <guid> non-empty The user's department ID.
firstName required	string [ 0 .. 255 ] characters The user's first name.
lastName required	string [ 0 .. 255 ] characters The user's last name.
middleName	string [ 0 .. 255 ] characters The user's middle name.
address	string [ 0 .. 4000 ] characters The user's address.
address2	string [ 0 .. 4000 ] characters The user's second address.
city	string [ 0 .. 255 ] characters The user's city.
postalCode	string [ 0 .. 255 ] characters The user's postal code.
provinceId	string <guid> The user's province ID.
countryId	string <guid> The user's country ID.
location	string [ 0 .. 255 ] characters The user's location
dateHired	string <date-time> The date the user was hired.
dateTerminated	string <date-time> The date the user was terminated.
emailAddress	string [ 0 .. 255 ] characters ^[a-zA-Z0-9!#$%&'*+\/=?^_`{|}~-]+(\.[a-zA-Z0-... The user's email address.
ccEmailAddresses	Array of strings The user's cc email addresses.
employeeNumber	string [ 0 .. 255 ] characters The user's employee number.
supervisorId	string <guid> The user's supervisor's ID.
externalId	string [ 0 .. 255 ] characters The user's external ID.
languageId	integer <int32> The user's default language ID.
gender	integer Enum: 0 1 2 The user's gender. Possible Enum Values: 0 = None 1 = Male 2 = Female
activeStatus	integer Enum: 0 1 The user's active status. Possible Enum Values: 0 = Active 1 = Inactive
jobTitle	string [ 0 .. 255 ] characters The user's job title.
notes	string Notes about the user.
phone	string [ 0 .. 255 ] characters The user's phone number.
referenceNumber	string [ 0 .. 255 ] characters The user's reference number.
roleIds	Array of strings <guid> [ items <guid > ] The user's associated role IDs.
isLearner	boolean True if the user is a learner, otherwise false.
isInstructor	boolean True if the user is an instructor, otherwise false.
isAdmin	boolean True if the user is an admin, otherwise false.
hasUsername	boolean True if the user has a username, otherwise false.
	object The user's custom fields.

Responses

Response Schema: application/json

Array

key	string The user's unique ID.
value	string The user property (key/correlation) used to create/update a user.

Response Schema: application/json

Array

key	string The user's unique ID.
value	string The user property (key/correlation) used to create/update a user.

US

https://rest.myabsorb.com/users/upload

CA

https://rest.myabsorb.ca/users/upload

EU

https://rest.myabsorb.eu/users/upload

AU

https://rest.myabsorb.com.au/users/upload

Request samples

• Payload

Content type

application/json

[

• {

  • "username": "string",
  • "password": "string",
  • "departmentId": "string",
  • "firstName": "string",
  • "lastName": "string",
  • "middleName": "string",
  • "address": "string",
  • "address2": "string",
  • "city": "string",
  • "postalCode": "string",
  • "provinceId": "string",
  • "countryId": "string",
  • "location": "string",
  • "dateHired": "2019-08-24T14:15:22Z",
  • "dateTerminated": "2019-08-24T14:15:22Z",
  • "emailAddress": "string",
  • "ccEmailAddresses": [

    • "string"

    ],
  • "employeeNumber": "string",
  • "supervisorId": "string",
  • "externalId": "string",
  • "languageId": 0,
  • "gender": 0,
  • "activeStatus": 0,
  • "jobTitle": "string",
  • "notes": "string",
  • "phone": "string",
  • "referenceNumber": "string",
  • "roleIds": [

    • "string"

    ],
  • "isLearner": true,
  • "isInstructor": true,
  • "isAdmin": true,
  • "hasUsername": true,
  • "customFields": {

    • "decimal1": 0,
    • "decimal2": 0,
    • "decimal3": 0,
    • "decimal4": 0,
    • "decimal5": 0,
    • "string1": "string",
    • "string2": "string",
    • "string3": "string",
    • "string4": "string",
    • "string5": "string",
    • "string6": "string",
    • "string7": "string",
    • "string8": "string",
    • "string9": "string",
    • "string10": "string",
    • "string11": "string",
    • "string12": "string",
    • "string13": "string",
    • "string14": "string",
    • "string15": "string",
    • "string16": "string",
    • "string17": "string",
    • "string18": "string",
    • "string19": "string",
    • "string20": "string",
    • "string21": "string",
    • "string22": "string",
    • "string23": "string",
    • "string24": "string",
    • "string25": "string",
    • "string26": "string",
    • "string27": "string",
    • "string28": "string",
    • "string29": "string",
    • "string30": "string",
    • "datetime1": "2019-08-24T14:15:22Z",
    • "datetime2": "2019-08-24T14:15:22Z",
    • "datetime3": "2019-08-24T14:15:22Z",
    • "datetime4": "2019-08-24T14:15:22Z",
    • "datetime5": "2019-08-24T14:15:22Z",
    • "bool1": true,
    • "bool2": true,
    • "bool3": true,
    • "bool4": true,
    • "bool5": true

    }

  }

]

Response samples

• 200
• 201
• 400
• 422
• 500

Content type

application/json

[

• {

  • "key": "string",
  • "value": "string"

  }

]

Update user management settings.

Authorizations:

api_key

path Parameters

userId required

string <guid> The user ID.

header Parameters

x-api-key	string
x-api-version	string 1

Request Body schema: application/json

The request to update the user's management settings.

userManagementType required	integer Enum: 1 2 3 The type of admin the user should be updated to. Possible Enum Values: 1 = Group 2 = Department 3 = All
managedGroupId	string <guid> The id of the group the user should manage.
	Array of objects (DepartmentSelectionDefinition) The list of departments the user should manage.

Responses

US

https://rest.myabsorb.com/users/{userId}/user-management-settings

CA

https://rest.myabsorb.ca/users/{userId}/user-management-settings

EU

https://rest.myabsorb.eu/users/{userId}/user-management-settings

AU

https://rest.myabsorb.com.au/users/{userId}/user-management-settings

Request samples

• Payload

Content type

application/json

{

• "userManagementType": 1,
• "managedGroupId": "string",
• "managedDepartments": [

  • {

    • "departmentId": "string",
    • "includeSubDepartments": true

    }

  ]

}

Response samples

• 400
• 403
• 404

Content type

application/json

{

• "validations": [

  • "string"

  ],
• "code": 0,
• "message": "string",
• "term": "string",
• "_meta": {

  • "property1": "string",
  • "property2": "string"

  }

}

Get currently authenticated User's details.

Authorizations:

api_key

header Parameters

x-api-key	string
x-api-version	string 1

Responses

Response Schema: application/json

id	string <guid> The unique user identifier.
departmentId	string <guid> The user's department ID.
firstName	string The first name.
middleName	string The middle name.
lastName	string The last name.
username	string The unique username.
password	string [ 0 .. 255 ] characters Password Required for User Creation.
emailAddress	string The user contact email address.
externalId	string The external ID used for integrations with external systems.
ccEmailAddresses	Array of strings List of email addresses, maximum 5 (MaxCcEmailSize)
languageId	integer <int32> The language id.
gender	integer Enum: 0 1 2 The gender. Possible Enum Values: 0 = None 1 = Male 2 = Female
address	string The mailing address.
address2	string The mailing address, part two.
city	string The city.
provinceId	string <guid> The province id.
countryId	string <guid> The country id.
postalCode	string The postal/zip code.
phone	string The phone number.
employeeNumber	string The employee number.
location	string The location.
jobTitle	string The job title.
referenceNumber	string The reference number.
dateHired	string <date-time> If applicable, the date the user was hired.
dateTerminated	string <date-time> If applicable, the date the user's employment was terminated.
dateEdited	string <date-time> The date the user is edited.
dateAdded	string <date-time> The date the user was added.
lastLoginDate	string <date-time> The last date the user successfully logged in.
notes	string The notes.
	object The custom fields.
roleIds	Array of strings <guid> [ items <guid > ] The role ids.
activeStatus	integer Enum: 0 1 The user's active status as UserActiveStatus . Possible Enum Values: 0 = Active 1 = Inactive
isLearner	boolean True if the user is a learner, otherwise false.
isAdmin	boolean True if the user is an administrator, otherwise false.
isInstructor	boolean True if the user is an instructor, otherwise false.
isManager	boolean True if the user is a manager, otherwise false.
supervisorId	string <guid> The supervisor id.
hasUsername	boolean Determines whether the user has a username or not.

US

https://rest.myabsorb.com/my-details

CA

https://rest.myabsorb.ca/my-details

EU

https://rest.myabsorb.eu/my-details

AU

https://rest.myabsorb.com.au/my-details

Response samples

• 200
• 404

Content type

application/json

{

• "id": "string",
• "departmentId": "string",
• "firstName": "string",
• "middleName": "string",
• "lastName": "string",
• "username": "string",
• "password": "string",
• "emailAddress": "string",
• "externalId": "string",
• "ccEmailAddresses": [

  • "string"

  ],
• "languageId": 0,
• "gender": 0,
• "address": "string",
• "address2": "string",
• "city": "string",
• "provinceId": "string",
• "countryId": "string",
• "postalCode": "string",
• "phone": "string",
• "employeeNumber": "string",
• "location": "string",
• "jobTitle": "string",
• "referenceNumber": "string",
• "dateHired": "2019-08-24T14:15:22Z",
• "dateTerminated": "2019-08-24T14:15:22Z",
• "dateEdited": "2019-08-24T14:15:22Z",
• "dateAdded": "2019-08-24T14:15:22Z",
• "lastLoginDate": "2019-08-24T14:15:22Z",
• "notes": "string",
• "customFields": {

  • "decimal1": 0,
  • "decimal2": 0,
  • "decimal3": 0,
  • "decimal4": 0,
  • "decimal5": 0,
  • "string1": "string",
  • "string2": "string",
  • "string3": "string",
  • "string4": "string",
  • "string5": "string",
  • "string6": "string",
  • "string7": "string",
  • "string8": "string",
  • "string9": "string",
  • "string10": "string",
  • "string11": "string",
  • "string12": "string",
  • "string13": "string",
  • "string14": "string",
  • "string15": "string",
  • "string16": "string",
  • "string17": "string",
  • "string18": "string",
  • "string19": "string",
  • "string20": "string",
  • "string21": "string",
  • "string22": "string",
  • "string23": "string",
  • "string24": "string",
  • "string25": "string",
  • "string26": "string",
  • "string27": "string",
  • "string28": "string",
  • "string29": "string",
  • "string30": "string",
  • "datetime1": "2019-08-24T14:15:22Z",
  • "datetime2": "2019-08-24T14:15:22Z",
  • "datetime3": "2019-08-24T14:15:22Z",
  • "datetime4": "2019-08-24T14:15:22Z",
  • "datetime5": "2019-08-24T14:15:22Z",
  • "bool1": true,
  • "bool2": true,
  • "bool3": true,
  • "bool4": true,
  • "bool5": true

  },
• "roleIds": [

  • "string"

  ],
• "activeStatus": 0,
• "isLearner": true,
• "isAdmin": true,
• "isInstructor": true,
• "isManager": true,
• "supervisorId": "string",
• "hasUsername": true

}

Competencies

Lists the competencies for a user.

Authorizations:

api_key

path Parameters

userId required

string <guid> The user ID.

query Parameters

_filter	string One or more filter operations to be performed on the collection. The referenced fields must allow filtering. See the respective report's schema for which fields can be filtered. Supports most of the OData filter syntax. Supported operations: * eq, * ne, * gt, * ge, * lt, * le, * and, * or, * not, * () Supported functions: * substringof('value',fieldName), * endswith(fieldName,'value'), * startswith(fieldName,'value'), * tolower(fieldName), * toupper(fieldName) Examples: _filter=firstname eq 'Jeffrey' _filter=id eq guid'a14c149a-2ce0-41d4-b532-02189ad3cb22' _filter=startsWith(lastname,'leb') or dateAdded ge datetime'1998-03-06T20:38:07Z'
_sort	string Optional list of comma-separated fields to sort the collection by. The referenced fields must allow sorting. See the respective report's schema for which fields can be sorted. If not specified, all report fields are returned. To sort in a descending manner, prefix the field name with -. For example, _sort=name,-date, sorts the collection of items by name (ascending) and then by date (descending).
_limit	string The maximum number of items to return in the current page of the collection.
_offset	string The number of pages to offset into the collection.

header Parameters

x-api-key	string
x-api-version	string 1

Responses

Response Schema: application/json

totalItems	integer <int32> The total number of items in the unbounded collection
returnedItems	integer <int32> The number of items in the bound collection being returned
limit	integer <int32> The current page size for the collection
offset	integer <int32> The current offset for the collection
	Array of objects (CompetencyResource) A list of CompetencyResources.

US

https://rest.myabsorb.com/users/{userId}/competencies

CA

https://rest.myabsorb.ca/users/{userId}/competencies

EU

https://rest.myabsorb.eu/users/{userId}/competencies

AU

https://rest.myabsorb.com.au/users/{userId}/competencies

Response samples

• 200
• 404
• 422

Content type

application/json

{

• "totalItems": 0,
• "returnedItems": 0,
• "limit": 0,
• "offset": 0,
• "competencies": [

  • {

    • "id": "string",
    • "name": "string",
    • "competencyLevel": 0,
    • "categoryName": "string",
    • "dateAcquired": "2019-08-24T14:15:22Z"

    }

  ]

}