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

UiPath Entities API

Perform CRUD operations on custom data entity records

UiPath Entities API is one of 32 APIs that UiPath publishes on the APIs.io network, described by a machine-readable OpenAPI specification and an AsyncAPI event-driven specification.

This API exposes 15 JSON Schema definitions.

Tagged areas include Entities. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an AsyncAPI specification, a JSON-LD context, and 15 JSON Schemas.

This API exposes 6 operations across 3 paths, and defines 8 schemas. It is described by OpenAPI 3.1.0, at version 1.0.

Requests are made against a single base URL, https://cloud.uipath.com/{orgName}/{tenantName}/automationhub_/api/v1.

6 operations 3 paths 8 schemas 1 DELETE2 GET2 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
1.0
Base URL
https://cloud.uipath.com/{organizationName}/{tenantName}/orchestrator_
Authentication
API Key
Terms of Service
Resource Areas
1

Authentication & Security 1

UiPath Entities API declares 1 security scheme for authenticating requests. An API key is passed in the header as Authorization (apiKeyAuth). By default, every request must be authenticated.

  • apiKeyAuth — API token generated from the Automation Hub Admin Console under Platform Setup Open API. Include as a Bearer token in the Authorization header: "Bearer {token}…

Paths & Operations 6

Across 3 paths, the API surfaces 6 operations — 1 DELETE, 2 GET, 2 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Entities 6

Perform CRUD operations on custom data entity records

GET
/{entityName}
UiPath List Records for an Entity
listEntityRecords 7 params → 200400401403404
POST
/{entityName}
UiPath Create an Entity Record
createEntityRecord 1 param body → 200400401403
GET
/{entityName}/{recordId}
UiPath Get an Entity Record by ID
getEntityRecord 4 params → 200401403404
PUT
/{entityName}/{recordId}
UiPath Update an Entity Record
updateEntityRecord 2 params body → 200400401403404
DELETE
/{entityName}/{recordId}
UiPath Delete an Entity Record
deleteEntityRecord 2 params → 204401403404
POST
/{entityName}/query
UiPath Query Entity Records with Advanced Filtering
queryEntityRecords 1 param body → 200400401

Schemas 8

The contract defines 8 schemas that model the data the API accepts and returns. The most detailed are EntityQueryRequest (5 properties), EntityRecord (5 properties), ErrorResponse (3 properties), FilterGroup (3 properties). Each schema is shown below with its type and property counts.

EntityQueryRequest
object
Advanced query request with structured filter conditions
5 properties
OrderByClause
object
Sort specification for query results
2 properties 1 required
EntityRecordInput
object
Input payload for creating or updating an entity record. The specific fields required depend on the entity schema definition. System-managed fields (Id, Create…
EntityRecord
object
A single entity record. The specific fields available depend on the entity schema configured in the tenant's Data Service. All records include the following sy…
5 properties
ErrorResponse
object
Standard error response body
3 properties
QueryFilter
object
A single field comparison condition in a query
3 properties 3 required
FilterGroup
object
A group of filter conditions joined by a logical operator
3 properties
EntityRecordCollection
object
A paginated collection of entity records
3 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

uipath-entities-api-openapi.yml Raw ↑

Other APIs UiPath publishes across the network.

UiPath Alerts API
UiPath AppInventory API
UiPath Assets API
UiPath AuditLogs API
UiPath Automations API
UiPath Classification API
UiPath Digitization API
UiPath Discovery API
UiPath Extraction API
UiPath Folders API
UiPath Groups API
UiPath Jobs API
Where this information came from

This is an independent, third-party profile of UiPath Entities 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.