shortUrls

Requires at least one of the permissions marketing:link:read, marketing:link:write or settings:integration:read.

Lists the short links of your organization. Needs the marketing links read or write permission, or the integration settings read permission.

Errors: a failed call returns a GraphQL errors entry, not a field on the result, and data may be null or partial. Read the entry's extensions.code and message; every shape and code is in the Error reference.

Example:

GraphQL

query ShortUrls {
  shortUrls {
    id
    shortCode
    title
    createdAt
    clickCount
    createdBy
  }
}

cURL

curl -X POST "https://<api-host>/graphql" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  --data @- <<'EOF'
{
  "query": "query ShortUrls {\n  shortUrls {\n    id\n    shortCode\n    title\n    createdAt\n    clickCount\n    createdBy\n  }\n}"
}
EOF

Response:

{
  "data": {
    "shortUrls": [
      {
        "id": "string",
        "shortCode": "string",
        "title": "string",
        "createdAt": "2025-01-15T00:00:00Z",
        "clickCount": 0,
        "createdBy": "string"
      }
    ]
  }
}

shortUrls: [ShortUrlEntity!]!

Type

ShortUrlEntity object

A short link.