Skip to main content
POST
Call links.shorten

Authorizations

Authorization
string
header
required

An API key minted at Settings › API & MCP. Send it as Authorization: Bearer <key>. A key carries its holder's own permissions, resolved on every call — revoking a membership closes the key's reach immediately. Keep it in an environment variable (GOOSY_API_KEY), never in a committed file.

Headers

x-request-id
string

Your own id for this request, echoed back and recorded on the audit trail. 1–128 characters from A–Z a–z 0–9 . _ : -, starting with a letter or digit; anything else is replaced by a generated id.

Maximum string length: 128

Body

application/json
target_url
string
required

The secure (https) web address people should land on. Always a page this brand owns.

source_kind
enum<string>
required

What the link is going out ON. Use manual only when it belongs to nothing in the system.

Available options:
post_version,
email,
ad,
sms,
link_page,
manual
source_id
string

The id of the post, email, ad or page it belongs to. Required for every kind except manual — it is what makes re-running this safe.

platform
string

Where it is going out: instagram, facebook, linkedin, email, sms… Defaults to manual.

campaign
string | null

The campaign this belongs to, if it is part of one.

workspace
string

Which workspace to run in — its slug. Omit to use your default. With more than one reachable workspace and no default, the call is refused and the choices are listed.

Minimum string length: 1

Response

The call was admitted and dispatched. ok says whether the tool succeeded — a refusal the tool itself produced is still a 200, exactly as it is a successful JSON-RPC result over MCP.

The tool ran and answered.

ok
boolean
required
short_url
string
required
goes_out_on
string
required
points_at
string
required
already_existed
boolean
required
workspace
string
required

The slug of the workspace this call ran in.

working_in
object
required

Which workspace this call ran in, and how that was decided. Present on every workspace-scoped result.