Skip to content

Company User Master Data Api (1.0)

Download OpenAPI description
OpenAPISpecification.json
Languages
Servers
https://www.developers.traceone.com/

Companies

Operations

Users

Operations

Get User details by Id

Request

Get User details by Id

Security
Bearer
Path
idstring(uuid)required
curl -i -X GET \
  'https://www.developers.traceone.com/api/users/{id}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Success

Bodyapplication/json
userIdstring(uuid)
userFirstNamestring or null
userLastNamestring or null
userNotificationEmailstring or null
userLoginstring or null
owningCompanyIdstring or null(uuid)
userStatusstring or null
userPhotoUrlstring or null
isAccountAdministratorboolean
isMainContactboolean
userLockedboolean
userLockedDatestring or null(date-time)
userUnlockedDatestring or null(date-time)
userJobTitlestring or null
userJobTitleIdinteger or null(int32)
userPhonestring or null
userPhone2string or null
commentstring or null
userLanguagePreferencestring or null
userCivilitystring or null
responsibilitiesArray of strings or null(uuid)(List`1)
createdAtstring or null(date-time)
modifiedAtstring or null(date-time)
countrystring or null
timeZonestring or null
lastStatusUpdatedDatestring or null(date-time)
isContactManagerboolean
userLastLoggedInDatestring or null(date-time)Deprecated
Response
application/json
{
  "userId": "2c4a230c-5085-4924-a3e1-25fb4fc5965b",
  "userFirstName": "string",
  "userLastName": "string",
  "userNotificationEmail": "string",
  "userLogin": "string",
  "owningCompanyId": "29319626-28d5-4007-ad82-c5c51d564ec4",
  "userStatus": "string",
  "userPhotoUrl": "string",
  "isAccountAdministrator": true,
  "isMainContact": true,
  "userLocked": true,
  "userLockedDate": "2019-08-24T14:15:22Z",
  "userUnlockedDate": "2019-08-24T14:15:22Z",
  "userJobTitle": "string",
  "userJobTitleId": 0,
  "userPhone": "string",
  "userPhone2": "string",
  "comment": "string",
  "userLanguagePreference": "string",
  "userCivility": "string",
  "responsibilities": [
    "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  ],
  "createdAt": "2019-08-24T14:15:22Z",
  "modifiedAt": "2019-08-24T14:15:22Z",
  "userLastLoggedInDate": "2019-08-24T14:15:22Z",
  "country": "string",
  "timeZone": "string",
  "lastStatusUpdatedDate": "2019-08-24T14:15:22Z",
  "isContactManager": true
}

Search Users by filters

Request

Search Users by filters

Security
Bearer
Query
Userstring

Search a user by first name, last name, user email or user name

UserNamestring

Search a user by first name or last name

UserFirstNamestring
UserLastNamestring
UserNotificationEmailstring
UserLoginstring
OwningCompanyIdstring(uuid)
IsEnabledboolean
IsDisabledboolean
IsSuspendedboolean
IsDeactivatedboolean
IsAccountAdministratorboolean
IsMainContactboolean
IsLockedboolean
UserJobTitleinteger(int32)
Skipinteger(int32)
Takeinteger(int32)
curl -i -X GET \
  'https://www.developers.traceone.com/api/users/filters?User=string&UserName=string&UserFirstName=string&UserLastName=string&UserNotificationEmail=string&UserLogin=string&OwningCompanyId=497f6eca-6276-4993-bfeb-53cbbbba6f08&IsEnabled=true&IsDisabled=true&IsSuspended=true&IsDeactivated=true&IsAccountAdministrator=true&IsMainContact=true&IsLocked=true&UserJobTitle=0&Skip=0&Take=0' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Success

Bodyapplication/json
usersArray of objects or null(List`1)
skipAndTakeQueryStatsobject or null(SkipAndTakeQueryStats)
Response
application/json
{
  "users": [
    { … }
  ],
  "skipAndTakeQueryStats": {
    "totalCount": 0,
    "currentCount": 0
  }
}

Search Users by ids

Request

Search Users by ids

Security
Bearer
Body
userIdsArray of strings(uuid)(List`1)required

Max 1000 ids

curl -i -X POST \
  https://www.developers.traceone.com/api/users/collections \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json-patch+json' \
  -d '{
    "userIds": [
      "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    ]
  }'

Responses

Success

Bodyapplication/jsonArray [
userNamestring or null
owningCompanyNamestring or null
seUserIdstring or null(uuid)
seCompanyIdstring or null(uuid)
userIdstring(uuid)
userFirstNamestring or null
userLastNamestring or null
userNotificationEmailstring or null
userLoginstring or null
owningCompanyIdstring or null(uuid)
userStatusstring or null
userPhotoUrlstring or null
isAccountAdministratorboolean
isMainContactboolean
userLockedboolean
userLockedDatestring or null(date-time)
userUnlockedDatestring or null(date-time)
userJobTitlestring or null
userJobTitleIdinteger or null(int32)
userPhonestring or null
userPhone2string or null
commentstring or null
userLanguagePreferencestring or null
userCivilitystring or null
responsibilitiesArray of strings or null(uuid)(List`1)
createdAtstring or null(date-time)
modifiedAtstring or null(date-time)
countrystring or null
timeZonestring or null
lastStatusUpdatedDatestring or null(date-time)
isContactManagerboolean
userLastLoggedInDatestring or null(date-time)Deprecated
]
Response
application/json
[
  {
    "userName": "string",
    "owningCompanyName": "string",
    "seUserId": "c604a8cc-ed9f-46f0-af15-a8da16ee1a4f",
    "seCompanyId": "68ac9e5e-be05-4814-907a-889be2cb1304",
    "userId": "2c4a230c-5085-4924-a3e1-25fb4fc5965b",
    "userFirstName": "string",
    "userLastName": "string",
    "userNotificationEmail": "string",
    "userLogin": "string",
    "owningCompanyId": "29319626-28d5-4007-ad82-c5c51d564ec4",
    "userStatus": "string",
    "userPhotoUrl": "string",
    "isAccountAdministrator": true,
    "isMainContact": true,
    "userLocked": true,
    "userLockedDate": "2019-08-24T14:15:22Z",
    "userUnlockedDate": "2019-08-24T14:15:22Z",
    "userJobTitle": "string",
    "userJobTitleId": 0,
    "userPhone": "string",
    "userPhone2": "string",
    "comment": "string",
    "userLanguagePreference": "string",
    "userCivility": "string",
    "responsibilities": [ … ],
    "createdAt": "2019-08-24T14:15:22Z",
    "modifiedAt": "2019-08-24T14:15:22Z",
    "userLastLoggedInDate": "2019-08-24T14:15:22Z",
    "country": "string",
    "timeZone": "string",
    "lastStatusUpdatedDate": "2019-08-24T14:15:22Z",
    "isContactManager": true
  }
]

Get the list of Responsibilities of a User

Request

Get the list of Responsibilities of a User

Security
Bearer
Path
idstring(uuid)required
curl -i -X GET \
  'https://www.developers.traceone.com/api/users/{id}/responsibilities' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Success

Bodyapplication/jsonArray [
string(uuid)
]
Response
application/json
[
  "497f6eca-6276-4993-bfeb-53cbbbba6f08"
]

Get all the users linked to a target responsibility

Request

Get all the users linked to a target responsibility

Security
Bearer
Path
idstring(uuid)required
Query
CompanyIdstring(uuid)required
Skipinteger(int32)
Takeinteger(int32)
curl -i -X GET \
  'https://www.developers.traceone.com/api/responsibilities/{id}/users?CompanyId=497f6eca-6276-4993-bfeb-53cbbbba6f08&Skip=0&Take=0' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Success

Bodyapplication/json
usersArray of objects or null(List`1)
skipAndTakeQueryStatsobject or null(SkipAndTakeQueryStats)
Response
application/json
{
  "users": [
    { … }
  ],
  "skipAndTakeQueryStats": {
    "totalCount": 0,
    "currentCount": 0
  }
}

Registrations

Operations

Company Relations

Operations