ShortPen

Generate

Get organization

Get domains

Get folders

Get pixels

Analytics

Default

Production

Sandbox

The Generate section of the ShortPen API allows users to create short URLs for their links. By utilizing this functionality, users can easily generate custom short URLs, QR codes, and specify color and logo options for branding purposes. This section provides a convenient way to streamline link sharing and improve user experience.

The Generate section of the ShortPen API allows users to create short URLs for their links. By utilizing this functionality, users can easily generate custom short URLs, QR codes, and specify color and logo options for branding purposes. This section provides a convenient way to streamline link sharing and improve user experience.

The URL to be associated with the generated link.

The title to be displayed on the generated link.

title

A custom slug to be used in the URL of the generated link.

custom_slug

A flag to indicate whether a QR code should be generated for the link.

generate_qr

The parameter for the red color value in the generated link.

The parameter for the green color value in the generated link.

The parameter for the blue color value in the generated link.

The logo to be used for generating the link.

logo

The ID of the domain to which the link should be associated.

domain_id

(optional) The ID of the workspace to which the link should be associated. If empty, the first workspace of the organization will be used. (Call 'Get organization' endpoint to retrive possible values)

workspace_id

Accept

Authorization

The &quot;Get organization&quot; section allows users to retrieve information about the organization associated with their account. By accessing this section, users can access essential details and settings related to the organization, facilitating seamless management and integration tasks.

The "Get organization" section allows users to retrieve information about the organization associated with their account. By accessing this section, users can access essential details and settings related to the organization, facilitating seamless management and integration tasks.

Represents the resource being requested or acted upon in the API call.

resource

Specifies the desired content type for the response.

Contains the credentials necessary to authenticate the user agent with the server.

The &quot;Get domains&quot; section of the ShortPen API allows users to retrieve a list of available domains for creating short URLs. Users can explore and select from a variety of domain options to customize their shortened links. This feature enables users to enhance the branding and presentation of their shortened URLs.

The "Get domains" section of the ShortPen API allows users to retrieve a list of available domains for creating short URLs. Users can explore and select from a variety of domain options to customize their shortened links. This feature enables users to enhance the branding and presentation of their shortened URLs.

Contains the data that the client wants to submit or process through the POST request. This parameter is used to specify the specific resource being requested.

Specifies the format in which the client expects the response data to be returned. Accepted values include application/json.

Provides the credentials required to authenticate the request. This parameter is essential for verifying the identity of the user.

The &quot;Get folders&quot; section in the ShortPen API allows users to retrieve a list of folders associated with their account. This functionality enables users to organize their short URLs into logical groupings for easier management and navigation. With this feature, users can efficiently categorize and access their shortened links within the ShortPen platform.

The "Get folders" section in the ShortPen API allows users to retrieve a list of folders associated with their account. This functionality enables users to organize their short URLs into logical groupings for easier management and navigation. With this feature, users can efficiently categorize and access their shortened links within the ShortPen platform.

(optional) filter by workspace, if empty, the first workspace of the organization will be used.

Retrieve pixel data associated with your project to track and analyze user interactions. This section enables you to fetch information about pixels.

Retrieve pixel data associated with your project to track and analyze user interactions. This section enables you to fetch information about pixels.

The Analytics section provides tools to access comprehensive data insights for your workspace. By leveraging this functionality, users can retrieve detailed analytics reports to monitor performance, identify trends, and make informed decisions based on usage patterns within specified timeframes.

The Analytics section provides tools to access comprehensive data insights for your workspace. By leveraging this functionality, users can retrieve detailed analytics reports to monitor performance, identify trends, and make informed decisions based on usage patterns within specified timeframes.

start

(optional) filter analytics by a single URL.

url_id

The Me section in ShortPen allows users to test the authentication status of their API connection. By sending a request to this section, users can verify that their authentication credentials are valid and functioning correctly. This essential feature ensures a secure and reliable connection to the ShortPen API for seamless integration and communication.

The Me section in ShortPen allows users to test the authentication status of their API connection. By sending a request to this section, users can verify that their authentication credentials are valid and functioning correctly. This essential feature ensures a secure and reliable connection to the ShortPen API for seamless integration and communication.

The Authorization header parameter is used to authenticate the request and grant access to the ShortPen API. It should include the bearer token obtained during the authentication process.

Sections