Get Amplify link

Get an Amplify link by ID, with its actions, target posts, and variant copy and media. Asset URLs are signed and expire after 24 hours.

GET/amplify-links/{id}

Authorization

AuthorizationBearer token · headerrequired

API key authentication. Generate an API key from your workspace settings.

Path parameters

idstring<uuid>required

The unique identifier of the Amplify link

Responses

200

Amplify link details

idstring<uuid>

titlestring

statestring

draft until published, live until endAt, then completed

Allowed:draftlivecompleted

publishedAtstring<date-time> | null

endAtstring<date-time> | null

When the link stops accepting new engagements

createdAtstring<date-time>

createdByobject

Show properties

idstring<uuid>

firstNamestring | null

lastNamestring | null

labelsobject[]

Show properties

Array of object

idstring<uuid>

namestring

shortLinkstring | null

Share URL recipients open. Set once the link is published.

actionCountnumber

actionsAmplifyLinkAction[]

Show properties

Array of AmplifyLinkAction

idstring<uuid>

actionTypestring

EngageScheduledPost: recipients like, comment on, or repost targetPost. CreateNewPost: recipients publish their own post from a variant.

Allowed:EngageScheduledPostCreateNewPost

allowLikeboolean

allowCommentboolean

allowRepostboolean

targetPostobject | null

The post recipients engage with. Only set for EngageScheduledPost actions.

Show properties

ordinalPostIdstring<uuid> | null

linkedInUrlstring | null

Set once the target post is live on LinkedIn

linkedInContentobject

A live LinkedIn post that was not created in Ordinal has copy only, no assets.

Show properties

copystring

Post text. LinkedIn mentions use the @[Display Name](urn) format described in LinkedIn Mentions.

assetsAmplifyAsset[]

Show properties

Array of AmplifyAsset

idstring<uuid>

namestring

urlstring | null

Signed download URL that needs no auth. Expires at urlExpiresAt; fetch the link again for a fresh URL rather than storing it.

urlExpiresAtstring<date-time>

When url stops working, 24 hours after the request

mimetypestring

sizenumber

File size in bytes

widthnumber | null

heightnumber | null

durationnumber | null

Duration in seconds for video

coverPhotoobject | null

Video thumbnail, when one was set

Show properties

idstring<uuid>

namestring

urlstring | null

Signed download URL that needs no auth. Expires at urlExpiresAt; fetch the link again for a fresh URL rather than storing it.

urlExpiresAtstring<date-time>

When url stops working, 24 hours after the request

mimetypestring

sizenumber

File size in bytes

widthnumber | null

heightnumber | null

durationnumber | null

Duration in seconds for video

variantsobject[]

Suggested copy and media recipients start from

Show properties

Array of object

idstring<uuid>

positionnumber

linkedInContentobject | null

Show properties

copystring

Post text. LinkedIn mentions use the @[Display Name](urn) format described in LinkedIn Mentions.

assetsAmplifyAsset[]

Show properties

Array of AmplifyAsset

idstring<uuid>

namestring

urlstring | null

Signed download URL that needs no auth. Expires at urlExpiresAt; fetch the link again for a fresh URL rather than storing it.

urlExpiresAtstring<date-time>

When url stops working, 24 hours after the request

mimetypestring

sizenumber

File size in bytes

widthnumber | null

heightnumber | null

durationnumber | null

Duration in seconds for video

coverPhotoobject | null

Video thumbnail, when one was set

Show properties

idstring<uuid>

namestring

urlstring | null

Signed download URL that needs no auth. Expires at urlExpiresAt; fetch the link again for a fresh URL rather than storing it.

urlExpiresAtstring<date-time>

When url stops working, 24 hours after the request

mimetypestring

sizenumber

File size in bytes

widthnumber | null

heightnumber | null

durationnumber | null

Duration in seconds for video

401

Unauthorized - Missing or invalid API key

codestring

messagestring

403

Forbidden - Amplify is not enabled for this workspace

codestring

messagestring

404

Not Found - Resource does not exist

codestring

messagestring

Try it

Server

Base URLCustom base URLOverrides the selected server when set.

Authorization

Bearer tokenRemember on this deviceInclude my values in samples

Parameters

idpath*The unique identifier of the Amplify link

Request

curl -X GET 'https://app.tryordinal.com/api/v1/amplify-links/497f6eca-6276-4993-bfeb-53cbbbba6f08' \
  -H 'Authorization: Bearer YOUR_TOKEN'

const response = await fetch("https://app.tryordinal.com/api/v1/amplify-links/497f6eca-6276-4993-bfeb-53cbbbba6f08", {
  method: "GET",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN"
  }
});

import requests

response = requests.get(
    "https://app.tryordinal.com/api/v1/amplify-links/497f6eca-6276-4993-bfeb-53cbbbba6f08",
    headers={
        "Authorization": "Bearer YOUR_TOKEN"
    },
)

Response

{
  "id": "550e8400-e29b-41d4-a716-446655441200",
  "title": "Q4 product launch",
  "state": "live",
  "publishedAt": "2026-11-10T15:00:00.000Z",
  "endAt": "2026-11-17T15:00:00.000Z",
  "createdAt": "2026-11-09T18:22:00.000Z",
  "createdBy": {
    "id": "550e8400-e29b-41d4-a716-446655440100",
    "firstName": "Jordan",
    "lastName": "Lee"
  },
  "labels": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440500",
      "name": "Launch"
    }
  ],
  "shortLink": "https://amp.tryordinal.com/q4-launch",
  "actionCount": 1,
  "actions": [
    {
      "id": "550e8400-e29b-41d4-a716-446655441220",
      "actionType": "EngageScheduledPost",
      "allowLike": true,
      "allowComment": true,
      "allowRepost": true,
      "targetPost": {
        "ordinalPostId": "550e8400-e29b-41d4-a716-446655440300",
        "linkedInUrl": "https://www.linkedin.com/feed/update/urn:li:share:7262000000000000000",
        "linkedInContent": {
          "copy": "Our Q4 release is live. Here's what's new.",
          "assets": [
            {
              "id": "550e8400-e29b-41d4-a716-446655441210",
              "name": "launch-graphic.png",
              "url": "https://storage.tryordinal.com/signed/launch-graphic.png?token=...",
              "urlExpiresAt": "2026-11-12T10:00:00.000Z",
              "mimetype": "image/png",
              "size": 284512,
              "width": 1200,
              "height": 627,
              "duration": null
            }
          ],
          "coverPhoto": null
        }
      },
      "variants": [
        {
          "id": "550e8400-e29b-41d4-a716-446655441230",
          "position": 0,
          "linkedInContent": {
            "copy": "Proud of what the team shipped this quarter.",
            "assets": [],
            "coverPhoto": null
          }
        }
      ]
    }
  ]
}

{
  "code": "UNAUTHORIZED",
  "message": "Invalid or unauthorized API key"
}

{
  "code": "FORBIDDEN",
  "message": "Amplify is not enabled for this workspace."
}

{
  "code": "NOT_FOUND",
  "message": "Post not found or does not belong to this workspace"
}