Skip to main content
POST
/
links
/
list
List Links
curl --request POST \
  --url https://api.example.com/links/list \
  --header 'Content-Type: application/json' \
  --data '
{
  "organizationId": "<string>",
  "externalId": "<string>"
}
'
{
  "id": "<string>",
  "slug": "<string>",
  "name": "<string>",
  "targetUrl": "<string>",
  "organizationId": "<string>",
  "createdBy": "<string>",
  "expiresAt": {},
  "ogTitle": {},
  "externalId": {},
  "createdAt": "<string>",
  "updatedAt": "<string>"
}

​
Authentication

Requires API key with read:links scope.

​
Request Body

​
organizationId
string
required
Organization ID to list links for
​
externalId
string
Filter by external identifier

​
Response

Returns an array of link objects, ordered by creation date (newest first).
​
id
string
Link identifier
​
slug
string
URL slug
​
name
string
Display name
​
targetUrl
string
Destination URL
​
organizationId
string
Parent organization
​
createdBy
string
User who created the link
​
expiresAt
string | null
Expiration timestamp
​
ogTitle
string | null
Open Graph title
​
externalId
string | null
Your external identifier
​
createdAt
string
Creation timestamp
​
updatedAt
string
Last update timestamp

​
Example Request

curl -X POST https://api.databuddy.cc/links/list \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "organizationId": "org_abc123"
  }'

​
Example Response

[
  {
    "id": "lnk_xyz123",
    "slug": "launch",
    "name": "Product Launch",
    "targetUrl": "https://example.com/products/new",
    "organizationId": "org_abc123",
    "createdBy": "usr_456",
    "expiresAt": null,
    "expiredRedirectUrl": null,
    "ogTitle": "Check out our new product!",
    "ogDescription": "The best product launch of 2024",
    "ogImageUrl": "https://example.com/og-image.png",
    "ogVideoUrl": null,
    "iosUrl": null,
    "androidUrl": null,
    "externalId": null,
    "deletedAt": null,
    "createdAt": "2024-03-01T17:00:00Z",
    "updatedAt": "2024-03-01T17:00:00Z"
  }
]