Get Entity
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 authentication of the form Bearer <token>, where token is your auth token.
Path parameters
id
Headers
X-Polytomic-Version
Response
OK
data
Errors
401
Entities Get Request Unauthorized Error
403
Entities Get Request Forbidden Error
404
Entities Get Request Not Found Error
500
Entities Get Request Internal Server Error
