Skip to main content
GET
/
ideas
List ideas
curl --request GET \
  --url https://app.tryordinal.com/api/v1/ideas \
  --header 'Authorization: Bearer <token>'
{
  "ideas": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "url": "<string>",
      "title": "<string>",
      "channels": [
        "<string>"
      ],
      "status": "<string>",
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z",
      "linkedIn": {
        "profile": {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "name": "<string>",
          "detail": "<string>"
        },
        "copy": "<string>",
        "assets": [
          {
            "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "name": "<string>",
            "url": "<string>",
            "mimetype": "<string>",
            "size": 123,
            "width": 123,
            "height": 123,
            "duration": 123
          }
        ]
      },
      "x": {
        "profile": {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "name": "<string>",
          "detail": "<string>"
        },
        "tweets": [
          {
            "copy": "<string>",
            "assets": [
              {
                "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
                "name": "<string>",
                "url": "<string>",
                "mimetype": "<string>",
                "size": 123,
                "width": 123,
                "height": 123,
                "duration": 123
              }
            ]
          }
        ]
      }
    }
  ],
  "nextCursor": "<string>",
  "hasMore": true
}

Authorizations

​
Authorization
string
header
required

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

Query Parameters

​
limit
integer
default:20

Maximum number of ideas to return (1-100)

Required range: 1 <= x <= 100
​
cursor
string<uuid>

Cursor for pagination (idea ID from the last item of previous page)

​
ids

Fetch specific ideas by IDs

​
channel
enum<string>

Filter by channel

Available options:
LinkedIn,
Twitter
​
linkedInProfileId
string<uuid>

Filter by LinkedIn profile ID

​
xProfileId
string<uuid>

Filter by X/Twitter profile ID

​
labelIds

Filter by label IDs (ideas with any of these labels)

​
createdAtMin
string<date-time>

Filter ideas created on or after this date

​
createdAtMax
string<date-time>

Filter ideas created on or before this date

​
sortBy
enum<string>
default:createdAt

Field to sort by

Available options:
createdAt
​
sortOrder
enum<string>
default:desc

Sort order

Available options:
asc,
desc

Response

List of ideas

​
ideas
object[]
​
nextCursor
string | null

Cursor for the next page of results

​
hasMore
boolean

Whether there are more results