For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Log inBook a demo
GuidesAPI Reference
GuidesAPI Reference
  • API Reference
      • GETGet Entity
      • GETGet Partner Entity
Logo
Log inBook a demo
API ReferenceEntities

Get Entity

GET
https://app.polytomic.com/api/entities/:id
GET
/api/entities/:id
$curl https://app.polytomic.com/api/entities/248df4b7-aa70-47b8-a036-33ac447e668d \
>     -H "Authorization: Bearer <token>"
1{
2  "data": {
3    "canonical_path": "/api/syncs/0ecd09c1-b901-4d27-9053-f0367c427254/executions/8f63fd67-5d47-4cb2-a5fc-e8b933799065",
4    "context": {},
5    "id": "248df4b7-aa70-47b8-a036-33ac447e668d",
6    "organization_id": "248df4b7-aa70-47b8-a036-33ac447e668d",
7    "relationships": {},
8    "type": "sync_execution"
9  }
10}
Returns a resolved entity by ID. Looks up a UUID within the caller's current organization and returns the resource type plus enough context to fetch the canonical resource. This endpoint is useful when you have an execution, sync, model, connection, organization, or user UUID and need to determine what it refers to. The response always includes: - `id`: the UUID that was resolved. - `type`: the resolved entity type. - `canonical_path`: the canonical REST path for the resolved resource. The response may also include: - `relationships`: parent resources needed to address nested resources. - `context`: lightweight additional context, such as bulk sync `schema_ids`. For the normal user-scoped endpoint, `organization_id` is omitted from the response. Supported `type` values currently include: - `organization` - `user` - `connection` - `model` - `sync` - `sync_execution` - `bulk_sync` - `bulk_sync_execution` Examples: - A model sync execution resolves to a `sync_execution` and includes a `sync` relationship. - A bulk sync execution resolves to a `bulk_sync_execution`, includes a `bulk_sync` relationship, and may include `context.schema_ids`. If the UUID does not exist, or exists outside the caller's scoped organization, the endpoint returns `404`.
Was this page helpful?
Previous

Get Partner Entity

Next

Returns a resolved entity by ID.

Looks up a UUID within the caller’s current organization and returns the resource type plus enough context to fetch the canonical resource.

This endpoint is useful when you have an execution, sync, model, connection, organization, or user UUID and need to determine what it refers to.

The response always includes:

  • id: the UUID that was resolved.
  • type: the resolved entity type.
  • canonical_path: the canonical REST path for the resolved resource.

The response may also include:

  • relationships: parent resources needed to address nested resources.
  • context: lightweight additional context, such as bulk sync schema_ids.

For the normal user-scoped endpoint, organization_id is omitted from the response.

Supported type values currently include:

  • organization
  • user
  • connection
  • model
  • sync
  • sync_execution
  • bulk_sync
  • bulk_sync_execution

Examples:

  • A model sync execution resolves to a sync_execution and includes a sync relationship.
  • A bulk sync execution resolves to a bulk_sync_execution, includes a bulk_sync relationship, and may include context.schema_ids.

If the UUID does not exist, or exists outside the caller’s scoped organization, the endpoint returns 404.

Authentication

AuthorizationBearer
Bearer user API key
OR
AuthorizationBasic

Basic organization-scoped API key

Path parameters

idstringRequiredformat: "uuid"
UUID of the entity to resolve.

Headers

X-Polytomic-VersionstringOptional

Response

OK
dataobject

Errors

401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
500
Internal Server Error