Skip to content

API reference

Get your account

Return the account that owns an API key. Use it to check that a key works.

GEThttps://ishortn.ink/api/v1/me

Returns the account that owns the API key: its ID, email, name, plan and default domain. Automation tools such as Zapier, Make and n8n call it to test a connection, and it's a cheap way to check a key in your own code.

Request

No parameters.

curl "https://ishortn.ink/api/v1/me" \
  -H "x-api-key: YOUR_API_KEY"

Response

200 OK with the account.

FieldTypeDescription
idstringThe account ID.
emailstring | nullThe account's email address.
namestring | nullThe account's name.
planstringfree, pro or ultra: the plan the API applies to this key's requests. A cancelled plan counts until the end of the paid period.
defaultDomainstringThe domain new links use when a request leaves out domain. See Domains.
{
  "id": "user_2abc123",
  "email": "ada@example.com",
  "name": "Ada Lovelace",
  "plan": "pro",
  "defaultDomain": "isht.app"
}

Errors

Error bodies use the standard error shape, except the plan-gated 403.

StatusCodeMessageCause
401unauthorizedInvalid or missing API keySee Authentication.
403{"error": "API access requires Pro", "upgrade_url": "https://ishortn.ink/pricing"} (whole body)The key's account isn't on Pro or Ultra and its notice period has ended. See API access by plan.
429rate_limitedRate limit exceeded. Retry in N seconds.See Rate limits.

Something missing or unclear? Email support@ishortn.ink.