USERS

ACTIONS

Invoke the Action API to retrieve information about invoked Actions.

Operations

ADAPTIVE TEMPLATES

Invoke the API to retrieve information about invoked Actions.

Operations

ASSETS

Invoke the Asset API to create, retrieve, manipulate, and share Assets. This API also provides operations to manage Asset relationships and download Asset content.

Operations

AUTHENTICATION

Invoke the Authentication API to generate, refresh, and revoke access tokens. An access token is required to perform any authorized API operation.

Operations

CDN (Coming Soon!)

Tenovos Content Delivery Network (CDN) - Coming Soon!

Tenovos CDN: Pull Zone Overview

Tenovos CDN provides global content acceleration and optimization through a pull zone architecture, ensuring that your assets are delivered to end users with maximum speed, reliability, and efficiency. A Content Delivery Network (CDN) works by caching static content—such as images, videos, and other media—on servers distributed across the globe. When an asset is requested, the CDN serves it from the nearest edge location, reducing load times and offloading traffic from the origin server, which in this case is Tenovos DAM.

A pull zone is the core mechanism that powers this system. It automatically fetches content from the origin the first time it is requested, then caches it at the edge. Subsequent requests are served directly from the CDN cache, improving response times and reducing bandwidth consumption.

Through the Tenovos CDN API, you can create, update, and manage pull zones programmatically. Pull zones support advanced features such as global edge caching, cache purging, bandwidth controls, and real-time performance statistics like cache hit rate and geographic request distribution. Optional optimization settings allow you to enhance performance further by enabling image compression, WebP and AVIF support, and content minification.

With just a few API calls, you can fully integrate high-performance content delivery into your Tenovos workflows—no complex infrastructure required.

Operations

COLLECTIONS

Invoke the Collection API to create, retrieve, edit, and delete Collections. Collections are used to group and catalog related Assets for quick access and consumption. Collections can be configured as:

private: Visible only to the user who created the Collection.
secured: Visible to users with.

When retrieving the Assets within a Collection, the requesting user will only see the Assets that the user has access to view. For example, a librarian may see all Assets within a Collection, but a general consumer user may only see a portion of those Assets, due to limited security access.

Operations

METADATA ATTRIBUTES

Invoke the Metadata Attributes API to retrieve Metadata Attributes, and to create, read, update, and delete Metadata Attribute definitions. Metadata Attributes come in varying types, including Text, Date, Controlled Vocabulary, Tabular, and Cascading, and can be assigned to Metadata Groups and Templates.

Admin Endpoints (NEW!): Create, read, update, and delete Metadata Attributes. These endpoints require the Metadata Management admin privilege.

Operations

METADATA GROUPS

Invoke the Metadata Groups API to create, read, update, and delete Metadata Groups. A Metadata Group organizes related Metadata Attributes together for use within a Metadata Template.

Admin Endpoints (NEW!): These endpoints require the Metadata Management admin privilege.

Operations

METADATA TEMPLATES

Invoke the Metadata Templates API to create, read, update, and delete Metadata Templates, and to apply Metadata definition changes. A Metadata Template defines a set of Metadata Attributes that, when assigned to an Asset, become available for population on that Asset.

Admin Endpoints (NEW!): Create, read, update, and delete Metadata Templates. These endpoints require the Metadata Management admin privilege.

Operations

METADATA VOCABULARIES

Invoke the Controlled Vocabularies API to create, retrieve, update, and delete Controlled Vocabularies used to constrain the values available to a Metadata Attribute.

Operations

METADATA CASCADES

Invoke the Metadata Cascades API to create, retrieve, update, and delete Cascading Attributes, a Metadata Attribute type whose available values depend on the value selected in a parent Attribute.

Operations

METADATA TABLES

Invoke the Metadata Tables API to create, retrieve, update, and delete Tabular Attributes, a Metadata Attribute type that stores structured, multi-column data on an Asset.

Operations

SEARCH

Search for Collections by Collection name.

Perform Asset searches using keywords or Attribute-specific search terms using the Keyword Search endpoint.

Perform a scan on all assets based on search criteria using a cursor to page through the entire result set of assets.

Operations

REQUESTS

Invoke these API's to create new Requests and manage existing Requests.

Operations

SECURITY ROLES

Invoke the Security Roles API to retrieve, create, update, and delete Security Roles, and to retrieve the Permissions and Privileges that can be assigned to a Role to control what a user can see and do across the platform.

Operations

SECURITY TEMPLATES

Invoke the Security Templates API to retrieve, create, update, and delete Security Templates. A Security Template combines Security Roles and User Groups to define access to Assets and other objects in the platform.

Operations

SECURITY GROUPS

Invoke the Security User Groups API to retrieve, create, update, and delete Security User Groups used to organize users for the purpose of assigning security access.

Operations

USERS

Invoke the User API to retrieve User profile information.

Operations

Get Current User Profile

Request

Use this endpoint to get the user profile information for the account that you've authenticated against the Tenovos API with.
This is useful when needing to check which groups you are in which may restrict the API calls you can make.

Security

ApiKeyAuth or BasicAuth

Headers

X-API-Keystringrequired

Customer-specific API key required to invoke API.

Authorizationstringrequired

Provided by Authentication Token creation operation

curl -i -X GET \
  https://api.uat.tenovos.io/v1/user \
  -H 'Authorization: string' \
  -H 'X-API-Key: YOUR_API_KEY_HERE'

Responses

The Response Body is a JSON object.

Bodyapplication/json

userIdstring(uuid)

Current User ID

Example: "7d675ef0-f423-11e9-8071-89c0c4052141"

customerIdstring

Parent Customer ID

Example: "1234567890"

emailIdstring(email)

User email

Example: "erlich.bachman@piedpiper.com"

firstNamestring

User first name

Example: "Erlich"

lastNamestring

User last name

Example: "Bachman"

roleIdstring(uuid)

User role ID

Example: "7d5620e0-f423-11e9-8071-89c0c4052141"

statusstring

User account status

Example: "enabled"

groupsArray of strings(uuid)

List of group IDs that user belongs to

Example: ["7d6207c0-f423-11e9-8071-89c0c4052141"]

userNamestring or null

The username of the Tenovos user, created by the Administrator or user at the time of account creation. Can be null for federated user accounts.

Example: "erlich.bachman"

phonestring(phone)

Example: 15551234565

contactstring

The person designated as the sponsor/point of contact for this user

Example: "Richard Hendricks"

countrystring

The country in which the Tenovos user is located.

Example: "USA"

companystring

The company that the Tenovos user works for.

Example: "Pied Piper"

friendlyNamestring

A "friendlier" version of the username. Used in the UI display and provided by the user.

Example: "Erlich Bachman"

Response

application/json

{
  "userId": "7d675ef0-f423-11e9-8071-89c0c4052141",
  "customerId": "1234567890",
  "emailId": "erlich.bachman@piedpiper.com",
  "firstName": "Erlich",
  "lastName": "Bachman",
  "roleId": "7d5620e0-f423-11e9-8071-89c0c4052141",
  "status": "enabled",
  "groups": [
    "7d6207c0-f423-11e9-8071-89c0c4052141"
  ],
  "userName": "erlich.bachman",
  "phone": 15551234565,
  "contact": "Richard Hendricks",
  "country": "USA",
  "company": "Pied Piper",
  "friendlyName": "Erlich Bachman"
}

Create User

Request

Use this endpoint to create a new user account in the system. You must have User Management role privilege and Security Template Management role privilege in order to create a user and assign groups. This endpoint can be used to create local or federated users.

Average Response Time: 5140ms

Security

ApiKeyAuth or BasicAuth

Headers

X-API-Keystringrequired

Customer-specific API key required to invoke API.

Authorizationstringrequired

Provided by Authentication Token creation operation

Bodyapplication/jsonrequired

The Request Body must be a JSON object

firstNamestring[ 1 .. 50 ] charactersrequired

First Name of the User.

Example: "John"

lastNamestring[ 1 .. 50 ] charactersrequired

Last Name of the User.

Example: "Wick"

friendlyNamestring[ 1 .. 50 ] charactersrequired

Friendly Name of the User.

Example: "john.wick"

emailstring(email)[ 6 .. 75 ] charactersrequired

Email of the User.

Example: "john.wick@tenovos.com"

usernamestring(username)[ 1 .. 50 ] charactersrequired

Username of the User.

Example: "john.wick"

passwordstring(password)[ 8 .. 150 ] charactersrequired

Password of the User.

Example: "sdhg&uuUz78u"

accountTypestringrequired

Account Type of the User. Local accounts use a password; Federated accounts use an SSO service.

Enum"local""federated"

Example: "local"

customAttributesobject(UserCreateRequest_customAttributes)

userRoleIdstring(uuid)= 36 charactersrequired

ID of the User's role. Only one role is allowed.

Example: "1401df5e-3f13-4c88-a5a8-de64f6227a03"

groupsArray of strings(uuid)non-emptyrequired

List of group IDs the User belongs to. At least one group is required.

Example: ["7d6207c0-f423-11e9-8071-89c0c4052141"]

isVerifiedboolean

Optional flag indicating whether the user account is verified upon creation. This is only supported for customers using Auth0 authentication.

Example: true

curl -i -X POST \
  https://api.uat.tenovos.io/v1/user \
  -H 'Authorization: string' \
  -H 'Content-Type: application/json' \
  -H 'X-API-Key: YOUR_API_KEY_HERE' \
  -d '{
    "firstName": "John",
    "lastName": "Wick",
    "friendlyName": "john.wick",
    "email": "john.wick@tenovos.com",
    "username": "john.wick",
    "password": "sdhg&uuUz78u",
    "accountType": "local",
    "customAttributes": {
      "country": "USA",
      "company": "Tenovos",
      "phone": "",
      "contact": ""
    },
    "userRoleId": "1401df5e-3f13-4c88-a5a8-de64f6227a03",
    "groups": [
      "7d6207c0-f423-11e9-8071-89c0c4052141"
    ],
    "isVerified": true
  }'

Responses

The Response Body is a JSON object.

Bodyapplication/json

roleIdstring(uuid)

User role ID

Example: "7d5620e0-f423-11e9-8071-89c0c4052141"

statusstring

User account status

Example: "success"

Response

application/json

{
  "roleId": "7d5620e0-f423-11e9-8071-89c0c4052141",
  "status": "success"
}

Get User Profile by ID

Request

Current user will get its profile information in response. User will also get ID of a role assigned to them and a list of group IDs they belong to.

Average Response Time: 154ms

Security

ApiKeyAuth or BasicAuth

Path

idstring(uuid)= 36 charactersrequired

A User Profile ID.

Example: 4e428628-2537-40b5-91a4-5393cbf167df

Headers

X-API-Keystringrequired

Customer-specific API key required to invoke API.

Authorizationstringrequired

Provided by Authentication Token creation operation

curl -i -X GET \
  https://api.uat.tenovos.io/v1/user/4e428628-2537-40b5-91a4-5393cbf167df \
  -H 'Authorization: string' \
  -H 'X-API-Key: YOUR_API_KEY_HERE'

Responses

The Response Body will be a JSON object

Bodyapplication/json

userIdstring(uuid)

Current User ID

Example: "7d675ef0-f423-11e9-8071-89c0c4052141"

customerIdstring

Parent Customer ID

Example: "1234567890"

emailIdstring(email)

User email

Example: "erlich.bachman@piedpiper.com"

firstNamestring

User first name

Example: "Erlich"

lastNamestring

User last name

Example: "Bachman"

roleIdstring(uuid)

User role ID

Example: "7d5620e0-f423-11e9-8071-89c0c4052141"

statusstring

User account status

Example: "enabled"

groupsArray of strings(uuid)

List of group IDs that user belongs to

Example: ["7d6207c0-f423-11e9-8071-89c0c4052141"]

userNamestring or null

The username of the Tenovos user, created by the Administrator or user at the time of account creation. Can be null for federated user accounts.

Example: "erlich.bachman"

phonestring(phone)

Example: 15551234565

contactstring

The person designated as the sponsor/point of contact for this user

Example: "Richard Hendricks"

countrystring

The country in which the Tenovos user is located.

Example: "USA"

companystring

The company that the Tenovos user works for.

Example: "Pied Piper"

friendlyNamestring

A "friendlier" version of the username. Used in the UI display and provided by the user.

Example: "Erlich Bachman"

Response

application/json

{
  "userId": "7d675ef0-f423-11e9-8071-89c0c4052141",
  "customerId": "1234567890",
  "emailId": "erlich.bachman@piedpiper.com",
  "firstName": "Erlich",
  "lastName": "Bachman",
  "roleId": "7d5620e0-f423-11e9-8071-89c0c4052141",
  "status": "enabled",
  "groups": [
    "7d6207c0-f423-11e9-8071-89c0c4052141"
  ],
  "userName": "erlich.bachman",
  "phone": 15551234565,
  "contact": "Richard Hendricks",
  "country": "USA",
  "company": "Pied Piper",
  "friendlyName": "Erlich Bachman"
}

Update User Attributes

Request

Update User Profile attributes such as First Name, Last Name, Friendly Name, Email, Company, Country, Contact, Phone, and User Role. The user role can be updated by sending either role id or role name.

Average Response Time: 1587ms

Security

ApiKeyAuth or BasicAuth

Path

idstringrequired

Specify a User Profile ID.

Headers

X-API-Keystringrequired

Customer-specific API key required to invoke API.

Authorizationstringrequired

Provided by Authentication Token creation operation

Bodyapplication/jsonrequired

The Request Body must be a JSON object

firstNamestring

First Name of the user

Example: "John"

lastNamestring

Last Name of the user

Example: "Smith"

friendlyNamestring

Last Name of the user

Example: "John Smith"

emailstring

Email of the user

Example: "john.smith@company.com"

companystring

Company name of the user

Example: "John's Company Inc."

countrystring

Country of the user

Example: "USA"

contactnumber

Contact Number of the user

Example: 1234567890

phonenumber

Alternate phone number of the user

Example: 1234567890

userRoleIdstring(uuid)

User role id of the user

Example: "7d5620e0-f423-11e9-8071-89c0c4052141"

userRoleNamestring

User role name of the user

Example: "End user"

groupsArray of strings(uuid)

List of user group ids the user is part of

Example: ["7d6207c0-f423-11e9-8071-89c0c4052141"]

statusstring

Allows updating the users status to either enable or disabled. These values are case sensitive.

Enum"enabled""disabled"

Example: "enabled"

curl -i -X PATCH \
  'https://api.uat.tenovos.io/v1/user/{id}' \
  -H 'Authorization: string' \
  -H 'Content-Type: application/json' \
  -H 'X-API-Key: YOUR_API_KEY_HERE' \
  -d '{
    "firstName": "John",
    "lastName": "Smith",
    "friendlyName": "John Smith",
    "email": "john.smith@company.com",
    "company": "John'\''s Company Inc.",
    "country": "USA",
    "contact": 1234567890,
    "phone": 1234567890,
    "userRoleId": "7d5620e0-f423-11e9-8071-89c0c4052141",
    "userRoleName": "End user",
    "groups": [
      "7d6207c0-f423-11e9-8071-89c0c4052141"
    ],
    "status": "enabled"
  }'

Responses

The Response Body will be a JSON object

Bodyapplication/json

userIdstring(uuid)

Current User ID

Example: "7d675ef0-f423-11e9-8071-89c0c4052141"

customerIdstring

Parent Customer ID

Example: "1234567890"

emailIdstring(email)

User email

Example: "erlich.bachman@piedpiper.com"

firstNamestring

User first name

Example: "Erlich"

lastNamestring

User last name

Example: "Bachman"

roleIdstring(uuid)

User role ID

Example: "7d5620e0-f423-11e9-8071-89c0c4052141"

statusstring

User account status

Example: "enabled"

groupsArray of strings(uuid)

List of group IDs that user belongs to

Example: ["7d6207c0-f423-11e9-8071-89c0c4052141"]

userNamestring or null

The username of the Tenovos user, created by the Administrator or user at the time of account creation. Can be null for federated user accounts.

Example: "erlich.bachman"

phonestring(phone)

Example: 15551234565

contactstring

The person designated as the sponsor/point of contact for this user

Example: "Richard Hendricks"

countrystring

The country in which the Tenovos user is located.

Example: "USA"

companystring

The company that the Tenovos user works for.

Example: "Pied Piper"

friendlyNamestring

A "friendlier" version of the username. Used in the UI display and provided by the user.

Example: "Erlich Bachman"

Response

application/json

{
  "userId": "7d675ef0-f423-11e9-8071-89c0c4052141",
  "customerId": "1234567890",
  "emailId": "erlich.bachman@piedpiper.com",
  "firstName": "Erlich",
  "lastName": "Bachman",
  "roleId": "7d5620e0-f423-11e9-8071-89c0c4052141",
  "status": "enabled",
  "groups": [
    "7d6207c0-f423-11e9-8071-89c0c4052141"
  ],
  "userName": "erlich.bachman",
  "phone": 15551234565,
  "contact": "Richard Hendricks",
  "country": "USA",
  "company": "Pied Piper",
  "friendlyName": "Erlich Bachman"
}

Add User to Group

Request

Assign a Security Group to a User Profile.

Security

ApiKeyAuth or BasicAuth

Path

idstringrequired

Specify a User Profile ID.

Headers

X-API-Keystringrequired

Customer-specific API key required to invoke API.

Authorizationstringrequired

Provided by Authentication Token creation operation

Bodyapplication/jsonrequired

The Request Body must be a JSON object

userGroupIdstring(uuid)

group-id of a valid existing user-security-group of customer

Example: "7d6207c0-f423-11e9-8071-89c0c4052141"

userGroupNamestring

group-name of a valid existing user-security-group of a customer

curl -i -X PATCH \
  'https://api.uat.tenovos.io/v1/user/{id}/add-to-group' \
  -H 'Authorization: string' \
  -H 'Content-Type: application/json' \
  -H 'X-API-Key: YOUR_API_KEY_HERE' \
  -d '{
    "userGroupId": "7d6207c0-f423-11e9-8071-89c0c4052141",
    "userGroupName": "string"
  }'

Responses

The Response Body will be a JSON object

Bodyapplication/json

statusstring

Example: "success"

messagestring

Example: "User Profile update was successful"

Response

application/json

{
  "status": "success",
  "message": "User Profile update was successful"
}

Remove User from Group

Request

Remove an assigned Security Group from a User Profile.

Security

ApiKeyAuth or BasicAuth

Path

idstringrequired

Specify a User Profile ID.

Headers

X-API-Keystringrequired

Customer-specific API key required to invoke API.

Authorizationstringrequired

Provided by Authentication Token creation operation

Bodyapplication/jsonrequired

The Request Body must be a JSON object

userGroupIdstring(uuid)

group-id of a valid existing user-security-group of customer

Example: "7d6207c0-f423-11e9-8071-89c0c4052141"

userGroupNamestring

group-name of a valid existing user-security-group of a customer

curl -i -X PATCH \
  'https://api.uat.tenovos.io/v1/user/{id}/remove-from-group' \
  -H 'Authorization: string' \
  -H 'Content-Type: application/json' \
  -H 'X-API-Key: YOUR_API_KEY_HERE' \
  -d '{
    "userGroupId": "7d6207c0-f423-11e9-8071-89c0c4052141",
    "userGroupName": "string"
  }'

Responses

The Response Body will be a JSON object

Bodyapplication/json

statusstring

Example: "success"

messagestring

Example: "User Profile update was successful"

Response

application/json

{
  "status": "success",
  "message": "User Profile update was successful"
}

(NEW!) List Users (Paginated)

Request

Retrieve an offset-paginated, searchable list of users for the authenticated customer. Supports free-text search, status/role/group filtering, and server-side sorting.

This endpoint supersedes GET /user/search/{searchText} — it adds userName to the searchable fields and returns createdEpoch/lastUpdatedEpoch on every result.

Defaults:

from defaults to 0.
limit defaults to 100 (values above 100 are capped to 100).
sortField defaults to firstName.
order defaults to desc.

Business Rules:

searchTerm is trimmed and, when non-empty, matched as a case-insensitive substring against first name, last name, friendly name, email, status, phone, company, country, contact, userName, role name, and group name. Literal % and _ are treated as text, not SQL wildcards. Omitted returns all users — no * sentinel required.
role and group are comma-separated lists of role/group names (not ids); multiple values use OR logic.
status accepts enabled, disabled, pendingApproval. allDisabled is not a supported value and is rejected with 400. Omitted returns users of any status.
groupCount (as a sortField value) sorts by the number of group ids in the user's groups array; a user with no groups sorts as 0, never null. It does not add a groupCount field to the response.
roleName (as a sortField value) sorts using the user's associated role name.
status (as a sortField value) sorts alphabetically by the stored status value.
Each result includes both the id and display name for its role (roleId/roleName) and for each group (groupId/groupName) — the front end does not need to resolve ids to names itself.
connectUser indicates whether the user can access Tenovos Connect. connectRole holds that user's Tenovos Connect role and is null when connectUser is false. The connectUser query parameter filters on this same field: true returns only Tenovos Connect users, false returns only users who are not, and omitting it applies no filter at all rather than defaulting to either.

The user submitting the request must have the User Management privilege.

Security

ApiKeyAuth or BasicAuth

Query

searchTermstring

Case-insensitive substring match against first name, last name, friendly name, email, status, phone, company, country, contact, userName, role name, and group name. Literal % and _ are treated as text. Omitted returns all users.

Example: searchTerm=smith

rolestring

Comma-separated list of role names. Multiple values use OR logic.

Example: role=Admin,Content Editor

groupstring

Comma-separated list of group names. A user matches when they belong to at least one supplied group.

Example: group=Marketing

statusstring

Filters by account status. Omitted returns users of any status. allDisabled is not supported.

Enum"enabled""disabled""pendingApproval"

connectUserboolean

Filters by Tenovos Connect access, matching the connectUser field on each result. true returns only Tenovos Connect users; false returns only users who are not. Omitted applies no filter and returns both.

Example: connectUser=true

frominteger

Result offset from which to start. Defaults to 0.

Default 0

Example: from=0

limitinteger

Number of results to return per page. Defaults to 100, maximum 100 (values above 100 are capped).

Default 100

Example: limit=100

sortFieldstring

Field to sort results by. Defaults to firstName.

Default "firstName"

Enum"firstName""lastName""emailId""userName""friendlyName""status""phone""contact""country""company"

orderstring

Sort direction. Defaults to desc.

Default "desc"

Enum"asc""desc"

Headers

X-API-Keystringrequired

Customer-specific API key required to invoke API.

Authorizationstringrequired

Provided by Authentication Token creation operation.

curl -i -X GET \
  'https://api.uat.tenovos.io/v1/users?searchTerm=smith&role=Admin%2CContent+Editor&group=Marketing&status=enabled&connectUser=true&from=0&limit=100&sortField=firstName&order=asc' \
  -H 'Authorization: string' \
  -H 'X-API-Key: YOUR_API_KEY_HERE'

Responses

Offset-paginated list of users matching the search and filters.

Bodyapplication/json

usersArray of objects

Users on this page.

pageInfoobject

Response

application/json

{
  "users": [
    { … }
  ],
  "pageInfo": {
    "from": 0,
    "limit": 100,
    "total": 842,
    "hasNextPage": true
  }
}

(NEW!) Get User Status Counts

Request

Retrieve user totals by status for the authenticated customer, calculated in a single grouped query. Backs the User Management screen's status tabs without running a separate paginated GET /users query per status.

Business Rules:

This endpoint does not currently accept any query parameters — the counts always represent the complete user population for the authenticated customer and are unaffected by the search/filter state of GET /users. Filtering may be added later as an additive change.
All four properties are always returned, including 0 for a status with no matching users.
Pending-approval identification preserves the existing User Management status/update-attribution rules.

The user submitting the request must have the User Management privilege.

Security

ApiKeyAuth or BasicAuth

Headers

X-API-Keystringrequired

Customer-specific API key required to invoke API.

Authorizationstringrequired

Provided by Authentication Token creation operation.

curl -i -X GET \
  https://api.uat.tenovos.io/v1/users/status-counts \
  -H 'Authorization: string' \
  -H 'X-API-Key: YOUR_API_KEY_HERE'

Responses

User totals by status for the authenticated customer.

Bodyapplication/json

enabledinteger

Number of enabled users for the authenticated customer.

Example: 842

disabledinteger

Number of disabled users for the authenticated customer.

Example: 130

pendingApprovalinteger

Number of users considered pending approval by the existing User Management status rules.

Example: 12

totalinteger

Total number of users for the authenticated customer.

Example: 984

Response

application/json

{
  "enabled": 842,
  "disabled": 130,
  "pendingApproval": 12,
  "total": 984
}

Search User ProfilesDeprecated

Request

Use this endpoint to retrieve a list of User Profiles matching the search keyword provided in the request parameter. Do not enter your search term wrapped in quotation marks. Provided keyword will be matched against the user attributes case insensitively - First Name, Last Name, Friendly Name, Username, Email, Phone, Company, Contact, Country, Status, Group Names, and Role Name. Entering "*" as your search term will return all users. The response is formatted as an area of objects, with each user account being returned as an object, as well as a key called 'count', which indicates how many accounts met the search critera. A maximum limit of 100 accounts will be returned in the response. In the case that more than 100 accounts meet the search criteria, pagination using the optional 'from' and 'limit' query parameters will be required to retrieve all accounts.

The user performing this action must have the 'User Management' role privilege.

How to use pagination: Pagination should be used when the amount of user accounts that match the entered search term exceeds the amount of users (100) returned in a single response. Paginating through the results will require making more than one call to this endpoint. To retrieve the first 100 users, in your query parameters, set your 'from' value to 0, and your 'limit' value to 100. To return the next set of 100 users, leave your 'limit' value as 100, but set your 'from' value to 100.

Continue to repeat this process of adding 100 to your 'from' value until all user account results are captured.

Security

ApiKeyAuth or BasicAuth

Path

searchTextstringrequired

Specify searchText to search across user attributes.

Query

fromstringrequired

Specify the starting position for the next result set.

limitstringrequired

Specify the maximum number of records to return each call.

Headers

X-API-Keystringrequired

Customer-specific API key required to invoke API.

Authorizationstringrequired

Provided by Authentication Token creation operation

curl -i -X GET \
  'https://api.uat.tenovos.io/v1/user/search/{searchText}?from=string&limit=string' \
  -H 'Authorization: string' \
  -H 'X-API-Key: YOUR_API_KEY_HERE'

Responses

The Response Body will be a JSON object

Bodyapplication/json

statusstring

Example: "success"

dataArray of objects(User)

List of User objects

Response

application/json

{
  "status": "success",
  "data": [
    { … }
  ]
}

STORY BOARDS

Invoke the Story Boards API to retrieve and manage Story Boards. Story Boards are curated content experiences that combine collections, saved searches, and other content blocks into a single shareable view.

Coming Soon: Additional endpoints for creating, updating, and deleting Story Boards.

Operations

WEBHOOKS

Tenovos Webhook Subscriptions

For more information about our Webhooks, see the Webhook section of our Developer Portal

Operations

RIGHTS MANAGEMENT

Invoke the Rights Management API to manage rights-management associations between Projects, Agreements, Entities, and Rights.

Operations

PROOFING

Operations

API Endpoint Reference (1.5)CopyCopy for LLMCopy page as Markdown for LLMsView as MarkdownOpen this page as MarkdownOpen in ChatGPTGet insights from ChatGPTOpen in ClaudeGet insights from ClaudeConnect to CursorInstall MCP server on CursorConnect to VS CodeInstall MCP server on VS Code

ACTIONS

ADAPTIVE TEMPLATES

ASSETS

AUTHENTICATION

CDN (Coming Soon!)

COLLECTIONS

METADATA ATTRIBUTES

METADATA GROUPS

METADATA TEMPLATES

METADATA VOCABULARIES

METADATA CASCADES

METADATA TABLES

SEARCH

REQUESTS

SECURITY ROLES

SECURITY TEMPLATES

SECURITY GROUPS

USERS

Get Current User Profile

Request

Responses

Was this helpful?

Create User

RequestExpand all

Responses

Was this helpful?

Get User Profile by ID

Request

Responses

Was this helpful?

Update User Attributes

Request

Responses

Was this helpful?

Add User to Group

Request

Responses

Was this helpful?

Remove User from Group

Request

Responses

Was this helpful?

(NEW!) List Users (Paginated)

Request

Responses

Was this helpful?

(NEW!) Get User Status Counts

Request

Responses

Was this helpful?

Search User ProfilesDeprecated

Request

Responses

Was this helpful?

STORY BOARDS

WEBHOOKS

RIGHTS MANAGEMENT

PROOFING

API Endpoint Reference (1.5)
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude
Connect to Cursor
Install MCP server on Cursor
Connect to VS Code
Install MCP server on VS Code

Request