How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Converis Web Services (Read API)

The Converis Read API lets applications read data from a Converis research information management instance for use in other systems. The base URL must be adapted to the customer's own Converis domain; unauthenticated queries return only publicly visible data. Published contract: 24 operation(s).

Converis Web Services (Read API) is one of 26 APIs that Clarivate publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Converis, CRIS, and Research Information Management. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 24 operations across 19 paths, organized into 8 resource areas, and defines 23 schemas. It is described by OpenAPI 3.0.0, at version 2.0.

Requests are made against a single base URL, https://api.clarivate.com/converisreadapi.

24 operations 19 paths 23 schemas 2 DELETE16 GET4 POST2 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.0
API Version
2.0
Base URL
https://api.clarivate.com/converisreadapi
Authentication
HTTP Basic
Resource Areas
8

Authentication & Security 1

Converis Web Services (Read API) declares 1 security scheme for authenticating requests. It accepts HTTP basic authentication (BasicAuth).

  • BasicAuth — The authentication information has to be provided by the client application as Basic authentication header. This can be configured by an admin in Converis unde…

Paths & Operations 24

Across 19 paths, the API surfaces 24 operations — 2 DELETE, 16 GET, 4 POST, 2 PUT. They span 8 resource areas: Administration - User Delegations, Administration - User data, Configuration - Entity definitions, Configuration - Link entity definitions, Data - Entity, Data - Link entity, Data - File, Data - Tree. Each is listed below with its method, path, parameters, and response codes.

Administration - User Delegations 4

Perform User Delegation operations

POST
/admin/users/delegation
Create a User Delegation.
body → 201400401
PUT
/admin/users/delegation
Update a User Delegation.
body → 200400401
GET
/admin/users/delegation
Fetch User Delegations
10 params → 200400401
DELETE
/admin/users/delegation{delegation_id}
Delete a User Delegation.
1 param → 200400401
Administration - User data 5

Perform User operations

GET
/admin/users
Get all users
4 params → 200default
POST
/admin/users
Create user
body → 201default
GET
/admin/users/{username}
Get information of a specific user
1 param → 200default
PUT
/admin/users/{username}
Update user
1 param body → 200default
DELETE
/admin/users/{username}
Delete user
1 param → 200default
Configuration - Entity definitions 2

Get the configured entity definitions

GET
/config/entities
Get definition of all entities
5 params → 200default
GET
/config/entities/{type}
Get definition of an entity
4 params → 200default
Configuration - Link entity definitions 2

Get the configured entity definitions

GET
/config/linkentities
Get definition of all entities
4 params → 200default
GET
/config/linkentities/{link_type}
Get definition of a link entity
3 params → 200default
Data - Entity 4

Get the entity data

GET
/data/entities/{type}
Get all data of an entity
8 params → 200default
POST
/data/entities/{type}/query
Get all data of an entity filtered by query.
8 params body → 200default
GET
/data/entities/{type}/{id}
Get an entity data object
5 params → 200default
GET
/data/entities/{type}/linked/{link_type}/{id}
Get the linked data entity entries
11 params → 200default
Data - Link entity 4

Get the links between entity data

GET
/data/linkentities/{link_type}
Get all entries of a link entity type filtered by query
7 params → 200default
POST
/data/linkentities/{link_type}/query
Get all entries of a link entity type
7 params body → 200default
GET
/data/linkentities/{link_type}/{id}
Get a link entity data object
getEntityByName 4 params → 200default
GET
/data/linkentities/{link_type}/linked/{type}/{id}
Get the link entity data entries (Coming soon)
10 params → 200default
Data - File 1

Download files

GET
/data/file/{file_type}/{id}/download
Download the given file
4 params → 200default
Data - Tree 2

Get the links between entity data

GET
/data/tree/{link_type}/root
Get the root object from the tree structure of the given link entity type
4 params → 200default
GET
/data/tree/{link_type}/{start_node}
Get tree information by traversing it
7 params → 200default

Schemas 23

The contract defines 23 schemas that model the data the API accepts and returns. The most detailed are EntityData (13 properties), LinkEntityData (11 properties), EntityDefinition (11 properties), User (11 properties). Each schema is shown below with its type and property counts.

DefaultResponse
object
5 properties 5 required
UserDelegation
object
5 properties
UserDelegationValidity
object
2 properties
UserDelegationList
object
5 properties 5 required
UserRole
object
4 properties
UserList
object
5 properties 5 required
User
object
11 properties
LabelDefinition
object
2 properties 2 required
LinkReference
object
2 properties 2 required
EntityDefinition
object
11 properties 9 required
EntityDefinitionList
object
5 properties 5 required
LinkEntityDefinition
object
7 properties 7 required
LinkEntityDefinitionList
object
5 properties 5 required
AttributeDefinition
object
10 properties 1 required
WorkflowStep
object
2 properties 2 required
AttributeInputDefinition
object
4 properties
EntityDataList
object
5 properties 4 required
LinkEntityDataList
object
5 properties 4 required
EntityData
object
13 properties 10 required
LinkEntityData
object
11 properties
BasicData
object
5 properties 3 required
AttributeData
object
5 properties 3 required
ChoiceGroupData
object
3 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

clarivate-converisreadapi-openapi.json Raw ↑

Other APIs Clarivate publishes across the network.

Intellectual Property (IP) Data API
Derwent Sequence Search API
Web of Science Journals API
EndNote REST API
Converis Legacy API
Converis Additional APIs
InCites Document Level Metrics API
Web of Science API Expanded
Web of Science SUSHI COUNTER5 API
Converis CUD API
C3 AI API
Cortellis Drug Discovery Intelligence SUSHI COUNTER5 API
Where this information came from

This is an independent, third-party profile of Converis Web Services (Read API), published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.