Team API
API Documentation.

The API is available only to registered users with minimum Team subscription plan - API key can be generate in Team edit page

To interact with the Team URL shortening service, make a request to https://cutt.ly/team/API/index.php remotely (e.g., using the PHP file_get_contents function). Depending on the action you wish to perform—whether shortening a link, editing an existing short link, or accessing link analytics—you will need to include specific parameters in your request. The required parameters and their descriptions for each operation are outlined in the sections below.

Link shortening

Team Link Shortening API Parameters

Below is the list of all possible parameters for the Team Link Shortening API. Required parameters are marked with Required, while optional ones are marked with Optional.

Parameter	Value	Description	Requirement Level
key	`{{key}}`	Your API key. Required to authenticate your request.	Required
action	`shorten`	In order to shorten a link.	Required
url	`{{url}}`	URL you want to shorten. It must be encoded using `urlencode()`.	Required
name	`{{name}}`	Your desired short link – alias, if not already taken.	Optional
domain	`{{domainName}}`	Your desired domain to be used. Example: your-domain.co	Optional
noTitle	`1`	Disables getting the page title from the source page meta tag, resulting in faster API response time. Available for Team Enterprise plan.	Optional
public	`1`	Sets public click stats for shortened link via API.	Optional

Examples

PHP C# Java Python

                    
$url = urlencode('{{url}}');
$json = file_get_contents("https://cutt.ly/team/API/index.php?key={{key}}&action=shorten&url=$url&name={{name}}&domain={{domainName}}");
$data = json_decode ($json, true);
var_dump($data);

                    
public class Class1
    {
        private const string URL = "https://cutt.ly/team/API/index.php";
        private string urlParameters = "?key={{key}}&action=shorten&url={{url}}&name={{name}}&domain{{domainName}}";

        static void Main(string[] args)
        {
            HttpClient client = new HttpClient();
            client.BaseAddress = new Uri(URL);

            // Add an Accept header for JSON format.
            client.DefaultRequestHeaders.Accept.Add(
            new MediaTypeWithQualityHeaderValue("application/json"));

            // List data response.
            HttpResponseMessage response = client.GetAsync(urlParameters).Result;  // Blocking call! Program will wait here until a response is received or a timeout occurs.
            if (response.IsSuccessStatusCode)
            {
                // Parse the response body.
                var dataObjects = response.Content.ReadAsAsync>().Result;  //Make sure to add a reference to System.Net.Http.Formatting.dll
                foreach (var d in dataObjects)
                {
                    Console.WriteLine("{0}", d.Name);
                }
            }
            else
            {
                Console.WriteLine("{0} ({1})", (int)response.StatusCode, response.ReasonPhrase);
            }

            //Make any other calls using HttpClient here.

            //Dispose once all HttpClient calls are complete. This is not necessary if the containing object will be disposed of; for example in this case the HttpClient instance will be disposed automatically when the application terminates so the following call is superfluous.
            client.Dispose();
        }
    }

                    
import java.io.BufferedReader;
import java.io.IOException;
import java.io.InputStreamReader;
import java.net.HttpURLConnection;
import java.net.MalformedURLException;
import java.net.URL;

public class NetClientGet {

	public static void main(String[] args) {

	  try {

		URL url = new URL("https://cutt.ly/team/API/index.php?key={{key}}&action=shorten&url={{url}}&name={{name}}&domain={{domainName}}");
		HttpURLConnection conn = (HttpURLConnection) url.openConnection();
		conn.setRequestMethod("GET");
		conn.setRequestProperty("Accept", "application/json");

		if (conn.getResponseCode() != 200) {
			throw new RuntimeException("Failed : HTTP error code : "
					+ conn.getResponseCode());
		}

		BufferedReader br = new BufferedReader(new InputStreamReader(
			(conn.getInputStream())));

		String output;
		System.out.println("Output from Server .... \n");
		while ((output = br.readLine()) != null) {
			System.out.println(output);
		}

		conn.disconnect();

	  } catch (MalformedURLException e) {

		e.printStackTrace();

	  } catch (IOException e) {

		e.printStackTrace();

	  }

	}

}

                    
import urllib
import requests
key = '{{key}}'
action = 'shorten'
url = urllib.parse.quote('{{url}}')
name  = '{{name}}'
domain = '{{domainName}}'
r = requests.get('https://cutt.ly/team/API/index.php?key={}&action={}&url={}&name={}&domain={}'.format(key, action, url, name, domain))
print(r.text)

Errors

`400 Incorrect action`	Action is null or incorrect
`400 Url parameter is null`	Parameter url was not sent
`401 Unauthorized`	Your API key is incorrect and a json with parameter auth:false has been returned
`401 Subscription has expired`	Team owner's subscription has expired
`401 This domain is not owned by the team. To use this domain, it must be added to the team by the team owner.`	It occurs when Team does not own the provided domain. To use domain in Team - it must be added to the team by the Team Owner
`409 Provided link is already shortened`	Provided link's domain is a registered cutt.ly custom domain
`409 Provided link is incorrect`	Provided url is not a link
`409 Provided alias contains illegal characters`	Name parameter contains illegal characters

Example: Shorten URL - Team API

This example demonstrates shortening a URL using the Team API with the minimum required parameters.

Method	Endpoint URL
GET	https://cutt.ly/team/API/index.php?key=`{{key}}`&action=`shorten`&url=`{{url}}`

Parameter	Value	Description	Requirement Level
key	`{{key}}`	Your API key.	Required
action	`shorten`	In order to shorten a link.	Required
url	`{{url}}`	URL you want to shorten. It must be encoded using `urlencode()`.	Required

Ensure that the URL {{url}} is encoded properly using the urlencode() function to avoid issues with special characters or parameters in the link.

Example 2: Shorten URL with Alias

This example shows how to shorten a URL with an alias using the required parameters and an optional alias.

Method	Endpoint URL
GET	https://cutt.ly/team/API/index.php?key=`{{key}}`&action=`shorten`&url=`{{url}}`&name=`{{name}}`

Parameter	Value	Description	Requirement Level
key	`{{key}}`	Your API key.	Required
action	`shorten`	In order to shorten a link.	Required
url	`{{url}}`	URL you want to shorten. It must be encoded using `urlencode()`.	Required
name	`{{name}}`	Your desired short link - alias - if not already taken.	Optional

Remember to encode the URL using urlencode() to ensure proper interpretation of special characters or parameters.

Example 3: Shorten URL with Custom Domain

This example demonstrates how to shorten a URL with an alias and specify a custom domain using required and optional parameters.

Method	Endpoint URL
GET	https://cutt.ly/team/API/index.php?key=`{{key}}`&action=`shorten`&url=`{{url}}`&domain=`{{domainName}}`

Parameter	Value	Description	Requirement Level
key	`{{key}}`	Your API key.	Required
action	`shorten`	In order to shorten a link.	Required
url	`{{url}}`	URL you want to shorten. It must be encoded using `urlencode()`.	Required
domain	`{{domainName}}`	Your desired domain to be used. Example: your-domain.co	Optional