Skip to main content
GET
Get a tracking link creation

Authorizations

Authorization
string
header
required

An API key (onx_sk_…) created in OnlyX under Settings → API & MCP, or an OAuth access token (onx_at_…) issued to a connected app. Send it as Authorization: Bearer <credential>. API keys may also be sent as X-API-Key: <key>.

Path Parameters

creatorId
string
required

The creator id (cre_…).

creationId
string
required

The creationId returned by POST …/tracking-links.

Maximum string length: 256

Response

The creation's state: creating, completed (with the link) or failed (with the reason).

creationId
string
required

The creation id.

error
CreationError · object | null
required

Set when state is failed.

When completed and read back: the new link's id. May stay null for up to an hour after completion.

state
enum<string>
required

creating (poll again in 5 seconds or more), completed or failed.

Available options:
creating,
completed,
failed
url
string | null
required

When completed: the new link.