Skip to content
Ordinal
Esc
↑↓navigate↵open⌘Jpreview

List Amplify links

List Amplify links in the workspace, newest first. Returns summaries; get a link by ID for its actions, post copy, and media.

GET/amplify-links
Authorization
AuthorizationBearer token · headerrequired

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

Query parameters
statesstring

Comma-separated link states, e.g. draft,live. Omit for all states.

labelIdsstring

Comma-separated label IDs. Returns links with any of these labels.

createdByIdstring<uuid>

Filter to links created by this user

limitinteger

Maximum number of links to return (1-100)

min 1 · max 100 · default: 20
cursorstring<uuid>

nextCursor from the previous page

Responses
200

Amplify links

amplifyLinksAmplifyLinkSummary[]
Show properties
Array of AmplifyLinkSummary
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
nextCursorstring<uuid> | null

Cursor for the next page, or null on the last page

400

Bad Request - Invalid input parameters

codestring
messagestring
dataobject
Show properties
errorsobject
401

Unauthorized - Missing or invalid API key

codestring
messagestring
403

Forbidden - Amplify is not enabled for this workspace

codestring
messagestring
Try it
Server
Authorization
Parameters
Request
curl -X GET 'https://app.tryordinal.com/api/v1/amplify-links' \
  -H 'Authorization: Bearer YOUR_TOKEN'
Response
{
  "amplifyLinks": [
    {
      "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
    }
  ],
  "nextCursor": null
}