Fetch Resources

POST

get

curl --request POST \
  --url https://{environment}.shortpen.com/v1/get \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "resource": "domain"
}
'

{
  "success": true,
  "status_code": 200,
  "data": [
    {
      "id": 3,
      "domain": "go.shortpen.com",
      "url": "https://go.shortpen.com/",
      "active": true,
      "is_default": false
    }
  ],
  "message": ""
}

{
  "success": false,
  "status_code": 401,
  "message": "There was an error while processing your request.",
  "data": "<unknown>"
}

{
  "success": false,
  "status_code": 401,
  "message": "There was an error while processing your request.",
  "data": "<unknown>"
}

Retrieve supporting metadata such as domains, folders, pixels, and organization information. The response shape depends on the resource you request.

`resource` value	Description	Typical use cases
`domain`	Returns every active domain available to the organization, including default ShortPen domains. Each item exposes `id`, `domain`, `url`, `active`, and `is_default`.	Populate dropdowns when generating links or validating domain assignments.
`folder`	Lists folders for the provided `workspace_id`. Each entry contains `id` and `name`.	Mirror folder structure inside your own UI or automations.
`tag`	Lists tags for the provided `workspace_id`. Each entry contains `id`, `name`, and `color`.	Resolve the `tag_ids` to send when creating or editing links.
`pixel`	Lists tracking pixels scoped to the organization with `id`, `name`, and `unique_id`.	Attach conversions to links or refresh external systems (for example Shopify apps).
`organization`	Returns organization metadata (`name`, `logo`, `is_default_logo`, `workspaces`, `updated_at`). Workspaces include `id` and `name`.	Show organization pickers or hydrate onboarding flows.

Each successful response is wrapped in the standard envelope (success, status_code, data, message). The data property matches the structure described in the table above.

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

resource

enum<string>

required

Resource to fetch.

Available options:

domain,

folder,

tag,

pixel,

organization

workspace_id

integer

Workspace scope used for folder and tag lookups.

Response

Resource payload

success

boolean

required

Example:

true

status_code

integer

required

Example:

200

data

object

required

Show child attributes

message

string

Example:

""

Retrieve Click AnalyticsReturns raw click analytics for the specified date range. Results are scoped to the organization and optionally filtered by workspace or link.

curl --request POST \
  --url https://{environment}.shortpen.com/v1/get \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "resource": "domain"
}
'

{
  "success": true,
  "status_code": 200,
  "data": [
    {
      "id": 3,
      "domain": "go.shortpen.com",
      "url": "https://go.shortpen.com/",
      "active": true,
      "is_default": false
    }
  ],
  "message": ""
}

{
  "success": false,
  "status_code": 401,
  "message": "There was an error while processing your request.",
  "data": "<unknown>"
}

{
  "success": false,
  "status_code": 401,
  "message": "There was an error while processing your request.",
  "data": "<unknown>"
}

API reference

Core

Links

Resources

Authorizations

Body

Response