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 Partner Entity

GET
https://app.polytomic.com/api/organizations/entities/:id
GET
/api/organizations/entities/:id
$curl https://app.polytomic.com/api/organizations/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 within a partner organization scope. Looks up a UUID across organizations using partner authentication and returns the resource type plus enough context to fetch the canonical resource. This endpoint is intended for cross-organization partner workflows where the caller has an arbitrary UUID and needs to discover both the resource type and the organization it belongs 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. - `organization_id`: the organization that owns 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`. 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, the endpoint returns `404`.
Was this page helpful?
Previous

Get Global Error Subscribers

Next

Returns a resolved entity by ID within a partner organization scope.

Looks up a UUID across organizations using partner authentication and returns the resource type plus enough context to fetch the canonical resource.

This endpoint is intended for cross-organization partner workflows where the caller has an arbitrary UUID and needs to discover both the resource type and the organization it belongs 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.
  • organization_id: the organization that owns 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.

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, the endpoint returns 404.

Authentication

AuthorizationBearer
Bearer partner API key

Path parameters

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

Headers

X-Polytomic-VersionstringOptional

Response

OK
dataobject

Errors

403
Forbidden Error
404
Not Found Error
500
Internal Server Error