Developer API - Streamline integration and development

Getting Started

An API key is required for requests to be processed by the system. Once a user registers, an API key is automatically generated for this user. The API key must be sent with each request (see full example below). If the API key is not sent or is expired, there will be an error. Please make sure to keep your API key secret to prevent abuse.

Sign in to view your API key

Sign In

Authentication

To authenticate with the API system, you need to send your API key as an authorization token with each request. You can see sample code below.

curl --location --request POST 'https://s.pq.is/api/account' \
--header 'Authorization: Bearer YOURAPIKEY' \
--header 'Content-Type: application/json'

$curl = curl_init();
curl_setopt_array($curl, array(
    CURLOPT_URL => "https://s.pq.is/api/account",
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_MAXREDIRS => 2,
    CURLOPT_TIMEOUT => 10,
    CURLOPT_FOLLOWLOCATION => true,
    CURLOPT_CUSTOMREQUEST => "POST",
    CURLOPT_HTTPHEADER => [
        "Authorization: Bearer YOURAPIKEY",
        "Content-Type: application/json",
    ],
));
$response = curl_exec($curl);

var request = require('request');
var options = {
    'method': 'POST',
    'url': 'https://s.pq.is/api/account',
    'headers': {
        'Authorization': 'Bearer YOURAPIKEY',
        'Content-Type': 'application/json'
    },
    body: ''
};
request(options, function (error, response) {
    if (error) throw new Error(error);
    console.log(response.body);
});

import requests
url = "https://s.pq.is/api/account"
payload = {}
headers = {
    'Authorization': 'Bearer YOURAPIKEY',
    'Content-Type': 'application/json'
}
response = requests.request("GET", url, headers=headers, json=payload)
print(response.text)

var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Get, "https://s.pq.is/api/account");
request.Headers.Add("Authorization", "Bearer YOURAPIKEY");
var content = new StringContent("{}", System.Text.Encoding.UTF8, "application/json");
request.Content = content;
var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());

Rate Limit

Our API has a rate limiter to safeguard against spike in requests to maximize its stability. Our rate limiter is currently caped at 30 requests per 1 minute.

Several headers will be sent alongside the response and these can be examined to determine various information about the request.

Response Headers

X-RateLimit-Limit: 30 X-RateLimit-Remaining: 29 X-RateLimit-Reset: TIMESTAMP

Response Handling

All API response are returned in JSON format by default. To convert this into usable data, the appropriate function will need to be used according to the language. In PHP, the function json_decode() can be used to convert the data to either an object (default) or an array (set the second parameter to true). It is very important to check the error key as that provides information on whether there was an error or not. You can also check the header code.

Error Response Example

{
    "error": 1,
    "message": "An error occurred"
}

Account

GET https://s.pq.is/api/account

Get Account

To get information on the account, you can send a request to this endpoint and it will return data on the account.

curl --location --request GET 'https://s.pq.is/api/account' \
--header 'Authorization: Bearer YOURAPIKEY' \
--header 'Content-Type: application/json'

$curl = curl_init();
curl_setopt_array($curl, array(
    CURLOPT_URL => "https://s.pq.is/api/account",
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_MAXREDIRS => 2,
    CURLOPT_TIMEOUT => 10,
    CURLOPT_FOLLOWLOCATION => true,
    CURLOPT_CUSTOMREQUEST => "GET",
    CURLOPT_HTTPHEADER => [
        "Authorization: Bearer YOURAPIKEY",
        "Content-Type: application/json",
    ],
));
$response = curl_exec($curl);
curl_close($curl);
echo $response;

var request = require('request');
var options = {
    'method': 'GET',
    'url': 'https://s.pq.is/api/account',
    'headers': {
        'Authorization': 'Bearer YOURAPIKEY',
        'Content-Type': 'application/json'
    },
};
request(options, function (error, response) {
    if (error) throw new Error(error);
    console.log(response.body);
});

import requests
url = "https://s.pq.is/api/account"
payload = {}
headers = {
    'Authorization': 'Bearer YOURAPIKEY',
    'Content-Type': 'application/json'
}
response = requests.request("GET", url, headers=headers, json=payload)
print(response.text)

var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Get, "https://s.pq.is/api/account");
request.Headers.Add("Authorization", "Bearer YOURAPIKEY");
var content = new StringContent("{}", System.Text.Encoding.UTF8, "application/json");
request.Content = content;
var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());

Server Response

{
    "error": 0,
    "data": {
        "id": 1,
        "email": "sample@domain.com",
        "username": "sampleuser",
        "avatar": "https:\/\/domain.com\/content\/avatar.png",
        "status": "pro",
        "expires": "2022-11-15 15:00:00",
        "registered": "2020-11-10 18:01:43"
    }
}

PUT https://s.pq.is/api/account/update

Update Account

To update information on the account, you can send a request to this endpoint and it will update data on the account.

curl --location --request PUT 'https://s.pq.is/api/account/update' \
--header 'Authorization: Bearer YOURAPIKEY' \
--header 'Content-Type: application/json' \
--data-raw '{
    "email": "newemail@google.com",
    "password": "newpassword"
}'

$curl = curl_init();
curl_setopt_array($curl, array(
    CURLOPT_URL => "https://s.pq.is/api/account/update",
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_MAXREDIRS => 2,
    CURLOPT_TIMEOUT => 10,
    CURLOPT_FOLLOWLOCATION => true,
    CURLOPT_CUSTOMREQUEST => "PUT",
    CURLOPT_HTTPHEADER => [
        "Authorization: Bearer YOURAPIKEY",
        "Content-Type: application/json",
    ],
    CURLOPT_POSTFIELDS => '{
        "email": "newemail@google.com",
        "password": "newpassword"
    }',
));
$response = curl_exec($curl);
curl_close($curl);
echo $response;

var request = require('request');
var options = {
    'method': 'PUT',
    'url': 'https://s.pq.is/api/account/update',
    'headers': {
        'Authorization': 'Bearer YOURAPIKEY',
        'Content-Type': 'application/json'
    },
    body: JSON.stringify({
    "email": "newemail@google.com",
    "password": "newpassword"
}),
};
request(options, function (error, response) {
    if (error) throw new Error(error);
    console.log(response.body);
});

import requests
url = "https://s.pq.is/api/account/update"
payload = {
    "email": "newemail@google.com",
    "password": "newpassword"
}
headers = {
    'Authorization': 'Bearer YOURAPIKEY',
    'Content-Type': 'application/json'
}
response = requests.request("PUT", url, headers=headers, json=payload)
print(response.text)

var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Put, "https://s.pq.is/api/account/update");
request.Headers.Add("Authorization", "Bearer YOURAPIKEY");
var content = new StringContent("{\"email\":\"newemail@google.com\",\"password\":\"newpassword\"}", System.Text.Encoding.UTF8, "application/json");
request.Content = content;
var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());

Server Response

{
    "error": 0,
    "message": "Account has been successfully updated."
}

Branded Domains

GET https://s.pq.is/api/domains?limit=2&page=1

List Branded Domains

To get your branded domains via the API, you can use this endpoint. You can also filter data (See table for more info).

Parameter Description

limit (optional) Per page data result

page (optional) Current page request

curl --location --request GET 'https://s.pq.is/api/domains?limit=2&page=1' \
--header 'Authorization: Bearer YOURAPIKEY' \
--header 'Content-Type: application/json'

$curl = curl_init();
curl_setopt_array($curl, array(
    CURLOPT_URL => "https://s.pq.is/api/domains?limit=2&page=1",
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_MAXREDIRS => 2,
    CURLOPT_TIMEOUT => 10,
    CURLOPT_FOLLOWLOCATION => true,
    CURLOPT_CUSTOMREQUEST => "GET",
    CURLOPT_HTTPHEADER => [
        "Authorization: Bearer YOURAPIKEY",
        "Content-Type: application/json",
    ],
));
$response = curl_exec($curl);
curl_close($curl);
echo $response;

var request = require('request');
var options = {
    'method': 'GET',
    'url': 'https://s.pq.is/api/domains?limit=2&page=1',
    'headers': {
        'Authorization': 'Bearer YOURAPIKEY',
        'Content-Type': 'application/json'
    },
};
request(options, function (error, response) {
    if (error) throw new Error(error);
    console.log(response.body);
});

import requests
url = "https://s.pq.is/api/domains?limit=2&page=1"
payload = {}
headers = {
    'Authorization': 'Bearer YOURAPIKEY',
    'Content-Type': 'application/json'
}
response = requests.request("GET", url, headers=headers, json=payload)
print(response.text)

var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Get, "https://s.pq.is/api/domains?limit=2&page=1");
request.Headers.Add("Authorization", "Bearer YOURAPIKEY");
var content = new StringContent("{}", System.Text.Encoding.UTF8, "application/json");
request.Content = content;
var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());

Server Response

{
    "error": "0",
    "data": {
        "result": 2,
        "perpage": 2,
        "currentpage": 1,
        "nextpage": 1,
        "maxpage": 1,
        "domains": [
            {
                "id": 1,
                "domain": "https:\/\/domain1.com",
                "redirectroot": "https:\/\/rootdomain.com",
                "redirect404": "https:\/\/rootdomain.com\/404"
            },
            {
                "id": 2,
                "domain": "https:\/\/domain2.com",
                "redirectroot": "https:\/\/rootdomain2.com",
                "redirect404": "https:\/\/rootdomain2.com\/404"
            }
        ]
    }
}

POST https://s.pq.is/api/domain/add

Create a Branded Domain

A domain can be added using this endpoint. Please make sure the domain is correctly pointed to our server.

Parameter Description

domain (required) Branded domain including http or https

redirectroot (optional) Root redirect when someone visits your domain

redirect404 (optional) Custom 404 redirect

curl --location --request POST 'https://s.pq.is/api/domain/add' \
--header 'Authorization: Bearer YOURAPIKEY' \
--header 'Content-Type: application/json' \
--data-raw '{
    "domain": "https:\/\/domain1.com",
    "redirectroot": "https:\/\/rootdomain.com",
    "redirect404": "https:\/\/rootdomain.com\/404"
}'

$curl = curl_init();
curl_setopt_array($curl, array(
    CURLOPT_URL => "https://s.pq.is/api/domain/add",
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_MAXREDIRS => 2,
    CURLOPT_TIMEOUT => 10,
    CURLOPT_FOLLOWLOCATION => true,
    CURLOPT_CUSTOMREQUEST => "POST",
    CURLOPT_HTTPHEADER => [
        "Authorization: Bearer YOURAPIKEY",
        "Content-Type: application/json",
    ],
    CURLOPT_POSTFIELDS => '{
        "domain": "https:\/\/domain1.com",
        "redirectroot": "https:\/\/rootdomain.com",
        "redirect404": "https:\/\/rootdomain.com\/404"
    }',
));
$response = curl_exec($curl);
curl_close($curl);
echo $response;

var request = require('request');
var options = {
    'method': 'POST',
    'url': 'https://s.pq.is/api/domain/add',
    'headers': {
        'Authorization': 'Bearer YOURAPIKEY',
        'Content-Type': 'application/json'
    },
    body: JSON.stringify({
    "domain": "https:\/\/domain1.com",
    "redirectroot": "https:\/\/rootdomain.com",
    "redirect404": "https:\/\/rootdomain.com\/404"
}),
};
request(options, function (error, response) {
    if (error) throw new Error(error);
    console.log(response.body);
});

import requests
url = "https://s.pq.is/api/domain/add"
payload = {
    "domain": "https://domain1.com",
    "redirectroot": "https://rootdomain.com",
    "redirect404": "https://rootdomain.com/404"
}
headers = {
    'Authorization': 'Bearer YOURAPIKEY',
    'Content-Type': 'application/json'
}
response = requests.request("POST", url, headers=headers, json=payload)
print(response.text)

var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Post, "https://s.pq.is/api/domain/add");
request.Headers.Add("Authorization", "Bearer YOURAPIKEY");
var content = new StringContent("{\"domain\":\"https:\\/\\/domain1.com\",\"redirectroot\":\"https:\\/\\/rootdomain.com\",\"redirect404\":\"https:\\/\\/rootdomain.com\\/404\"}", System.Text.Encoding.UTF8, "application/json");
request.Content = content;
var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());

Server Response

{
    "error": 0,
    "id": 1
}

PUT https://s.pq.is/api/domain/:id/update

Update Domain

To update a branded domain, you need to send a valid data in JSON via a PUT request. The data must be sent as the raw body of your request as shown below. The example below shows all the parameters you can send but you are not required to send all (See table for more info).

Parameter Description

redirectroot (optional) Root redirect when someone visits your domain

redirect404 (optional) Custom 404 redirect

curl --location --request PUT 'https://s.pq.is/api/domain/:id/update' \
--header 'Authorization: Bearer YOURAPIKEY' \
--header 'Content-Type: application/json' \
--data-raw '{
    "redirectroot": "https:\/\/rootdomain-new.com",
    "redirect404": "https:\/\/rootdomain-new.com\/404"
}'

$curl = curl_init();
curl_setopt_array($curl, array(
    CURLOPT_URL => "https://s.pq.is/api/domain/:id/update",
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_MAXREDIRS => 2,
    CURLOPT_TIMEOUT => 10,
    CURLOPT_FOLLOWLOCATION => true,
    CURLOPT_CUSTOMREQUEST => "PUT",
    CURLOPT_HTTPHEADER => [
        "Authorization: Bearer YOURAPIKEY",
        "Content-Type: application/json",
    ],
    CURLOPT_POSTFIELDS => '{
        "redirectroot": "https:\/\/rootdomain-new.com",
        "redirect404": "https:\/\/rootdomain-new.com\/404"
    }',
));
$response = curl_exec($curl);
curl_close($curl);
echo $response;

var request = require('request');
var options = {
    'method': 'PUT',
    'url': 'https://s.pq.is/api/domain/:id/update',
    'headers': {
        'Authorization': 'Bearer YOURAPIKEY',
        'Content-Type': 'application/json'
    },
    body: JSON.stringify({
    "redirectroot": "https:\/\/rootdomain-new.com",
    "redirect404": "https:\/\/rootdomain-new.com\/404"
}),
};
request(options, function (error, response) {
    if (error) throw new Error(error);
    console.log(response.body);
});

import requests
url = "https://s.pq.is/api/domain/:id/update"
payload = {
    "redirectroot": "https://rootdomain-new.com",
    "redirect404": "https://rootdomain-new.com/404"
}
headers = {
    'Authorization': 'Bearer YOURAPIKEY',
    'Content-Type': 'application/json'
}
response = requests.request("PUT", url, headers=headers, json=payload)
print(response.text)

var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Put, "https://s.pq.is/api/domain/:id/update");
request.Headers.Add("Authorization", "Bearer YOURAPIKEY");
var content = new StringContent("{\"redirectroot\":\"https:\\/\\/rootdomain-new.com\",\"redirect404\":\"https:\\/\\/rootdomain-new.com\\/404\"}", System.Text.Encoding.UTF8, "application/json");
request.Content = content;
var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());

Server Response

{
    "error": 0,
    "message": "Domain has been updated successfully."
}

DELETE https://s.pq.is/api/domain/:id/delete

Delete Domain

To delete a domain, you need to send a DELETE request.

curl --location --request DELETE 'https://s.pq.is/api/domain/:id/delete' \
--header 'Authorization: Bearer YOURAPIKEY' \
--header 'Content-Type: application/json'

$curl = curl_init();
curl_setopt_array($curl, array(
    CURLOPT_URL => "https://s.pq.is/api/domain/:id/delete",
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_MAXREDIRS => 2,
    CURLOPT_TIMEOUT => 10,
    CURLOPT_FOLLOWLOCATION => true,
    CURLOPT_CUSTOMREQUEST => "DELETE",
    CURLOPT_HTTPHEADER => [
        "Authorization: Bearer YOURAPIKEY",
        "Content-Type: application/json",
    ],
));
$response = curl_exec($curl);
curl_close($curl);
echo $response;

var request = require('request');
var options = {
    'method': 'DELETE',
    'url': 'https://s.pq.is/api/domain/:id/delete',
    'headers': {
        'Authorization': 'Bearer YOURAPIKEY',
        'Content-Type': 'application/json'
    },
};
request(options, function (error, response) {
    if (error) throw new Error(error);
    console.log(response.body);
});

import requests
url = "https://s.pq.is/api/domain/:id/delete"
payload = {}
headers = {
    'Authorization': 'Bearer YOURAPIKEY',
    'Content-Type': 'application/json'
}
response = requests.request("DELETE", url, headers=headers, json=payload)
print(response.text)

var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Delete, "https://s.pq.is/api/domain/:id/delete");
request.Headers.Add("Authorization", "Bearer YOURAPIKEY");
var content = new StringContent("{}", System.Text.Encoding.UTF8, "application/json");
request.Content = content;
var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());

Server Response

{
    "error": 0,
    "message": "Domain has been deleted successfully."
}

CTA Overlays

GET https://s.pq.is/api/overlay?limit=2&page=1

List CTA Overlays

To get cta overlays via the API, you can use this endpoint. You can also filter data (See table for more info).

Parameter Description

limit (optional) Per page data result

page (optional) Current page request

curl --location --request GET 'https://s.pq.is/api/overlay?limit=2&page=1' \
--header 'Authorization: Bearer YOURAPIKEY' \
--header 'Content-Type: application/json'

$curl = curl_init();
curl_setopt_array($curl, array(
    CURLOPT_URL => "https://s.pq.is/api/overlay?limit=2&page=1",
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_MAXREDIRS => 2,
    CURLOPT_TIMEOUT => 10,
    CURLOPT_FOLLOWLOCATION => true,
    CURLOPT_CUSTOMREQUEST => "GET",
    CURLOPT_HTTPHEADER => [
        "Authorization: Bearer YOURAPIKEY",
        "Content-Type: application/json",
    ],
));
$response = curl_exec($curl);
curl_close($curl);
echo $response;

var request = require('request');
var options = {
    'method': 'GET',
    'url': 'https://s.pq.is/api/overlay?limit=2&page=1',
    'headers': {
        'Authorization': 'Bearer YOURAPIKEY',
        'Content-Type': 'application/json'
    },
};
request(options, function (error, response) {
    if (error) throw new Error(error);
    console.log(response.body);
});

import requests
url = "https://s.pq.is/api/overlay?limit=2&page=1"
payload = {}
headers = {
    'Authorization': 'Bearer YOURAPIKEY',
    'Content-Type': 'application/json'
}
response = requests.request("GET", url, headers=headers, json=payload)
print(response.text)

var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Get, "https://s.pq.is/api/overlay?limit=2&page=1");
request.Headers.Add("Authorization", "Bearer YOURAPIKEY");
var content = new StringContent("{}", System.Text.Encoding.UTF8, "application/json");
request.Content = content;
var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());

Server Response

{
    "error": "0",
    "data": {
        "result": 2,
        "perpage": 2,
        "currentpage": 1,
        "nextpage": 1,
        "maxpage": 1,
        "cta": [
            {
                "id": 1,
                "type": "message",
                "name": "Product 1 Promo",
                "date": "2020-11-10 18:00:00"
            },
            {
                "id": 2,
                "type": "contact",
                "name": "Contact Page",
                "date": "2020-11-10 18:10:00"
            }
        ]
    }
}

Campaigns

GET https://s.pq.is/api/campaigns?limit=2&page=1

List Campaigns

To get your campaigns via the API, you can use this endpoint. You can also filter data (See table for more info).

Parameter Description

limit (optional) Per page data result

page (optional) Current page request

curl --location --request GET 'https://s.pq.is/api/campaigns?limit=2&page=1' \
--header 'Authorization: Bearer YOURAPIKEY' \
--header 'Content-Type: application/json'

$curl = curl_init();
curl_setopt_array($curl, array(
    CURLOPT_URL => "https://s.pq.is/api/campaigns?limit=2&page=1",
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_MAXREDIRS => 2,
    CURLOPT_TIMEOUT => 10,
    CURLOPT_FOLLOWLOCATION => true,
    CURLOPT_CUSTOMREQUEST => "GET",
    CURLOPT_HTTPHEADER => [
        "Authorization: Bearer YOURAPIKEY",
        "Content-Type: application/json",
    ],
));
$response = curl_exec($curl);
curl_close($curl);
echo $response;

var request = require('request');
var options = {
    'method': 'GET',
    'url': 'https://s.pq.is/api/campaigns?limit=2&page=1',
    'headers': {
        'Authorization': 'Bearer YOURAPIKEY',
        'Content-Type': 'application/json'
    },
};
request(options, function (error, response) {
    if (error) throw new Error(error);
    console.log(response.body);
});

import requests
url = "https://s.pq.is/api/campaigns?limit=2&page=1"
payload = {}
headers = {
    'Authorization': 'Bearer YOURAPIKEY',
    'Content-Type': 'application/json'
}
response = requests.request("GET", url, headers=headers, json=payload)
print(response.text)

var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Get, "https://s.pq.is/api/campaigns?limit=2&page=1");
request.Headers.Add("Authorization", "Bearer YOURAPIKEY");
var content = new StringContent("{}", System.Text.Encoding.UTF8, "application/json");
request.Content = content;
var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());

Server Response

{
    "error": "0",
    "data": {
        "result": 2,
        "perpage": 2,
        "currentpage": 1,
        "nextpage": 1,
        "maxpage": 1,
        "campaigns": [
            {
                "id": 1,
                "name": "Sample Campaign",
                "public": false,
                "rotator": false,
                "list": "https:\/\/domain.com\/u\/admin\/list-1"
            },
            {
                "id": 2,
                "domain": "Facebook Campaign",
                "public": true,
                "rotator": "https:\/\/domain.com\/r\/test",
                "list": "https:\/\/domain.com\/u\/admin\/test-2"
            }
        ]
    }
}

POST https://s.pq.is/api/campaign/add

Create a Campaign

A campaign can be added using this endpoint.

Parameter Description

name (optional) Campaign name

slug (optional) Rotator Slug

public (optional) Access

curl --location --request POST 'https://s.pq.is/api/campaign/add' \
--header 'Authorization: Bearer YOURAPIKEY' \
--header 'Content-Type: application/json' \
--data-raw '{
    "name": "New Campaign",
    "slug": "new-campaign",
    "public": true
}'

$curl = curl_init();
curl_setopt_array($curl, array(
    CURLOPT_URL => "https://s.pq.is/api/campaign/add",
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_MAXREDIRS => 2,
    CURLOPT_TIMEOUT => 10,
    CURLOPT_FOLLOWLOCATION => true,
    CURLOPT_CUSTOMREQUEST => "POST",
    CURLOPT_HTTPHEADER => [
        "Authorization: Bearer YOURAPIKEY",
        "Content-Type: application/json",
    ],
    CURLOPT_POSTFIELDS => '{
        "name": "New Campaign",
        "slug": "new-campaign",
        "public": true
    }',
));
$response = curl_exec($curl);
curl_close($curl);
echo $response;

var request = require('request');
var options = {
    'method': 'POST',
    'url': 'https://s.pq.is/api/campaign/add',
    'headers': {
        'Authorization': 'Bearer YOURAPIKEY',
        'Content-Type': 'application/json'
    },
    body: JSON.stringify({
    "name": "New Campaign",
    "slug": "new-campaign",
    "public": true
}),
};
request(options, function (error, response) {
    if (error) throw new Error(error);
    console.log(response.body);
});

import requests
url = "https://s.pq.is/api/campaign/add"
payload = {
    "name": "New Campaign",
    "slug": "new-campaign",
    "public": true
}
headers = {
    'Authorization': 'Bearer YOURAPIKEY',
    'Content-Type': 'application/json'
}
response = requests.request("POST", url, headers=headers, json=payload)
print(response.text)

var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Post, "https://s.pq.is/api/campaign/add");
request.Headers.Add("Authorization", "Bearer YOURAPIKEY");
var content = new StringContent("{\"name\":\"New Campaign\",\"slug\":\"new-campaign\",\"public\":true}", System.Text.Encoding.UTF8, "application/json");
request.Content = content;
var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());

Server Response

{
    "error": 0,
    "id": 3,
    "domain": "New Campaign",
    "public": true,
    "rotator": "https:\/\/domain.com\/r\/new-campaign",
    "list": "https:\/\/domain.com\/u\/admin\/new-campaign-3"
}

POST https://s.pq.is/api/campaign/:campaignid/assign/:linkid

Assign a Link to a Campaign

A short link can be assigned to a campaign using this endpoint. The endpoint requires the campaign ID and the short link ID.

curl --location --request POST 'https://s.pq.is/api/campaign/:campaignid/assign/:linkid' \
--header 'Authorization: Bearer YOURAPIKEY' \
--header 'Content-Type: application/json'

$curl = curl_init();
curl_setopt_array($curl, array(
    CURLOPT_URL => "https://s.pq.is/api/campaign/:campaignid/assign/:linkid",
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_MAXREDIRS => 2,
    CURLOPT_TIMEOUT => 10,
    CURLOPT_FOLLOWLOCATION => true,
    CURLOPT_CUSTOMREQUEST => "POST",
    CURLOPT_HTTPHEADER => [
        "Authorization: Bearer YOURAPIKEY",
        "Content-Type: application/json",
    ],
));
$response = curl_exec($curl);
curl_close($curl);
echo $response;

var request = require('request');
var options = {
    'method': 'POST',
    'url': 'https://s.pq.is/api/campaign/:campaignid/assign/:linkid',
    'headers': {
        'Authorization': 'Bearer YOURAPIKEY',
        'Content-Type': 'application/json'
    },
};
request(options, function (error, response) {
    if (error) throw new Error(error);
    console.log(response.body);
});

import requests
url = "https://s.pq.is/api/campaign/:campaignid/assign/:linkid"
payload = {}
headers = {
    'Authorization': 'Bearer YOURAPIKEY',
    'Content-Type': 'application/json'
}
response = requests.request("POST", url, headers=headers, json=payload)
print(response.text)

var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Post, "https://s.pq.is/api/campaign/:campaignid/assign/:linkid");
request.Headers.Add("Authorization", "Bearer YOURAPIKEY");
var content = new StringContent("{}", System.Text.Encoding.UTF8, "application/json");
request.Content = content;
var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());

Server Response

{
    "error": 0,
    "message": "Link successfully added to the campaign."
}

PUT https://s.pq.is/api/campaign/:id/update

Update Campaign

To update a campaign, you need to send a valid data in JSON via a PUT request. The data must be sent as the raw body of your request as shown below. The example below shows all the parameters you can send but you are not required to send all (See table for more info).

Parameter Description

name (required) Campaign name

slug (optional) Rotator Slug

public (optional) Access

curl --location --request PUT 'https://s.pq.is/api/campaign/:id/update' \
--header 'Authorization: Bearer YOURAPIKEY' \
--header 'Content-Type: application/json' \
--data-raw '{
    "name": "Twitter Campaign",
    "slug": "twitter-campaign",
    "public": true
}'

$curl = curl_init();
curl_setopt_array($curl, array(
    CURLOPT_URL => "https://s.pq.is/api/campaign/:id/update",
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_MAXREDIRS => 2,
    CURLOPT_TIMEOUT => 10,
    CURLOPT_FOLLOWLOCATION => true,
    CURLOPT_CUSTOMREQUEST => "PUT",
    CURLOPT_HTTPHEADER => [
        "Authorization: Bearer YOURAPIKEY",
        "Content-Type: application/json",
    ],
    CURLOPT_POSTFIELDS => '{
        "name": "Twitter Campaign",
        "slug": "twitter-campaign",
        "public": true
    }',
));
$response = curl_exec($curl);
curl_close($curl);
echo $response;

var request = require('request');
var options = {
    'method': 'PUT',
    'url': 'https://s.pq.is/api/campaign/:id/update',
    'headers': {
        'Authorization': 'Bearer YOURAPIKEY',
        'Content-Type': 'application/json'
    },
    body: JSON.stringify({
    "name": "Twitter Campaign",
    "slug": "twitter-campaign",
    "public": true
}),
};
request(options, function (error, response) {
    if (error) throw new Error(error);
    console.log(response.body);
});

import requests
url = "https://s.pq.is/api/campaign/:id/update"
payload = {
    "name": "Twitter Campaign",
    "slug": "twitter-campaign",
    "public": true
}
headers = {
    'Authorization': 'Bearer YOURAPIKEY',
    'Content-Type': 'application/json'
}
response = requests.request("PUT", url, headers=headers, json=payload)
print(response.text)

var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Put, "https://s.pq.is/api/campaign/:id/update");
request.Headers.Add("Authorization", "Bearer YOURAPIKEY");
var content = new StringContent("{\"name\":\"Twitter Campaign\",\"slug\":\"twitter-campaign\",\"public\":true}", System.Text.Encoding.UTF8, "application/json");
request.Content = content;
var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());

Server Response

{
    "error": 0,
    "id": 3,
    "domain": "Twitter Campaign",
    "public": true,
    "rotator": "https:\/\/domain.com\/r\/twitter-campaign",
    "list": "https:\/\/domain.com\/u\/admin\/twitter-campaign-3"
}

DELETE https://s.pq.is/api/campaign/:id/delete

Delete Campaign

To delete a campaign, you need to send a DELETE request.

curl --location --request DELETE 'https://s.pq.is/api/campaign/:id/delete' \
--header 'Authorization: Bearer YOURAPIKEY' \
--header 'Content-Type: application/json'

$curl = curl_init();
curl_setopt_array($curl, array(
    CURLOPT_URL => "https://s.pq.is/api/campaign/:id/delete",
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_MAXREDIRS => 2,
    CURLOPT_TIMEOUT => 10,
    CURLOPT_FOLLOWLOCATION => true,
    CURLOPT_CUSTOMREQUEST => "DELETE",
    CURLOPT_HTTPHEADER => [
        "Authorization: Bearer YOURAPIKEY",
        "Content-Type: application/json",
    ],
));
$response = curl_exec($curl);
curl_close($curl);
echo $response;

var request = require('request');
var options = {
    'method': 'DELETE',
    'url': 'https://s.pq.is/api/campaign/:id/delete',
    'headers': {
        'Authorization': 'Bearer YOURAPIKEY',
        'Content-Type': 'application/json'
    },
};
request(options, function (error, response) {
    if (error) throw new Error(error);
    console.log(response.body);
});

import requests
url = "https://s.pq.is/api/campaign/:id/delete"
payload = {}
headers = {
    'Authorization': 'Bearer YOURAPIKEY',
    'Content-Type': 'application/json'
}
response = requests.request("DELETE", url, headers=headers, json=payload)
print(response.text)

var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Delete, "https://s.pq.is/api/campaign/:id/delete");
request.Headers.Add("Authorization", "Bearer YOURAPIKEY");
var content = new StringContent("{}", System.Text.Encoding.UTF8, "application/json");
request.Content = content;
var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());

Server Response

{
    "error": 0,
    "message": "Campaign has been deleted successfully."
}

Channels

GET https://s.pq.is/api/channels?limit=2&page=1

List Channels

To get your channels via the API, you can use this endpoint. You can also filter data (See table for more info).

Parameter Description

limit (optional) Per page data result

page (optional) Current page request

curl --location --request GET 'https://s.pq.is/api/channels?limit=2&page=1' \
--header 'Authorization: Bearer YOURAPIKEY' \
--header 'Content-Type: application/json'

$curl = curl_init();
curl_setopt_array($curl, array(
    CURLOPT_URL => "https://s.pq.is/api/channels?limit=2&page=1",
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_MAXREDIRS => 2,
    CURLOPT_TIMEOUT => 10,
    CURLOPT_FOLLOWLOCATION => true,
    CURLOPT_CUSTOMREQUEST => "GET",
    CURLOPT_HTTPHEADER => [
        "Authorization: Bearer YOURAPIKEY",
        "Content-Type: application/json",
    ],
));
$response = curl_exec($curl);
curl_close($curl);
echo $response;

var request = require('request');
var options = {
    'method': 'GET',
    'url': 'https://s.pq.is/api/channels?limit=2&page=1',
    'headers': {
        'Authorization': 'Bearer YOURAPIKEY',
        'Content-Type': 'application/json'
    },
};
request(options, function (error, response) {
    if (error) throw new Error(error);
    console.log(response.body);
});

import requests
url = "https://s.pq.is/api/channels?limit=2&page=1"
payload = {}
headers = {
    'Authorization': 'Bearer YOURAPIKEY',
    'Content-Type': 'application/json'
}
response = requests.request("GET", url, headers=headers, json=payload)
print(response.text)

var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Get, "https://s.pq.is/api/channels?limit=2&page=1");
request.Headers.Add("Authorization", "Bearer YOURAPIKEY");
var content = new StringContent("{}", System.Text.Encoding.UTF8, "application/json");
request.Content = content;
var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());

Server Response

{
    "error": "0",
    "data": {
        "result": 2,
        "perpage": 2,
        "currentpage": 1,
        "nextpage": 1,
        "maxpage": 1,
        "channels": [
            {
                "id": 1,
                "name": "Channel 1",
                "description": "Description of channel 1",
                "color": "#000000",
                "starred": true
            },
            {
                "id": 2,
                "name": "Channel 2",
                "description": "Description of channel 2",
                "color": "#FF0000",
                "starred": false
            }
        ]
    }
}

GET https://s.pq.is/api/channel/:id?limit=1&page=1

List Channel Items

To get items in a select channels via the API, you can use this endpoint. You can also filter data (See table for more info).

Parameter Description

limit (optional) Per page data result

page (optional) Current page request

curl --location --request GET 'https://s.pq.is/api/channel/:id?limit=1&page=1' \
--header 'Authorization: Bearer YOURAPIKEY' \
--header 'Content-Type: application/json'

$curl = curl_init();
curl_setopt_array($curl, array(
    CURLOPT_URL => "https://s.pq.is/api/channel/:id?limit=1&page=1",
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_MAXREDIRS => 2,
    CURLOPT_TIMEOUT => 10,
    CURLOPT_FOLLOWLOCATION => true,
    CURLOPT_CUSTOMREQUEST => "GET",
    CURLOPT_HTTPHEADER => [
        "Authorization: Bearer YOURAPIKEY",
        "Content-Type: application/json",
    ],
));
$response = curl_exec($curl);
curl_close($curl);
echo $response;

var request = require('request');
var options = {
    'method': 'GET',
    'url': 'https://s.pq.is/api/channel/:id?limit=1&page=1',
    'headers': {
        'Authorization': 'Bearer YOURAPIKEY',
        'Content-Type': 'application/json'
    },
};
request(options, function (error, response) {
    if (error) throw new Error(error);
    console.log(response.body);
});

import requests
url = "https://s.pq.is/api/channel/:id?limit=1&page=1"
payload = {}
headers = {
    'Authorization': 'Bearer YOURAPIKEY',
    'Content-Type': 'application/json'
}
response = requests.request("GET", url, headers=headers, json=payload)
print(response.text)

var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Get, "https://s.pq.is/api/channel/:id?limit=1&page=1");
request.Headers.Add("Authorization", "Bearer YOURAPIKEY");
var content = new StringContent("{}", System.Text.Encoding.UTF8, "application/json");
request.Content = content;
var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());

Server Response

{
    "error": "0",
    "data": {
        "result": 2,
        "perpage": 2,
        "currentpage": 1,
        "nextpage": 1,
        "maxpage": 1,
        "items": [
            {
                "type": "links",
                "id": 1,
                "title": "My Sample Link",
                "preview": "https:\/\/google.com",
                "link": "https:\/\/s.pq.is\/google",
                "date": "2022-05-12"
            },
            {
                "type": "bio",
                "id": 1,
                "title": "My Sample Bio",
                "preview": "https:\/\/s.pq.is\/mybio",
                "link": "https:\/\/s.pq.is\/mybio",
                "date": "2022-06-01"
            }
        ]
    }
}

POST https://s.pq.is/api/channel/add

Create a Channel

A channel can be added using this endpoint.

Parameter Description

name (required) Channel name

description (optional) Channel description

color (optional) Channel badge color (HEX)

starred (optional) Star the channel or not (true or false)

curl --location --request POST 'https://s.pq.is/api/channel/add' \
--header 'Authorization: Bearer YOURAPIKEY' \
--header 'Content-Type: application/json' \
--data-raw '{
    "name": "New Channel",
    "description": "my new channel",
    "color": "#000000",
    "starred": true
}'

$curl = curl_init();
curl_setopt_array($curl, array(
    CURLOPT_URL => "https://s.pq.is/api/channel/add",
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_MAXREDIRS => 2,
    CURLOPT_TIMEOUT => 10,
    CURLOPT_FOLLOWLOCATION => true,
    CURLOPT_CUSTOMREQUEST => "POST",
    CURLOPT_HTTPHEADER => [
        "Authorization: Bearer YOURAPIKEY",
        "Content-Type: application/json",
    ],
    CURLOPT_POSTFIELDS => '{
        "name": "New Channel",
        "description": "my new channel",
        "color": "#000000",
        "starred": true
    }',
));
$response = curl_exec($curl);
curl_close($curl);
echo $response;

var request = require('request');
var options = {
    'method': 'POST',
    'url': 'https://s.pq.is/api/channel/add',
    'headers': {
        'Authorization': 'Bearer YOURAPIKEY',
        'Content-Type': 'application/json'
    },
    body: JSON.stringify({
    "name": "New Channel",
    "description": "my new channel",
    "color": "#000000",
    "starred": true
}),
};
request(options, function (error, response) {
    if (error) throw new Error(error);
    console.log(response.body);
});

import requests
url = "https://s.pq.is/api/channel/add"
payload = {
    "name": "New Channel",
    "description": "my new channel",
    "color": "#000000",
    "starred": true
}
headers = {
    'Authorization': 'Bearer YOURAPIKEY',
    'Content-Type': 'application/json'
}
response = requests.request("POST", url, headers=headers, json=payload)
print(response.text)

var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Post, "https://s.pq.is/api/channel/add");
request.Headers.Add("Authorization", "Bearer YOURAPIKEY");
var content = new StringContent("{\"name\":\"New Channel\",\"description\":\"my new channel\",\"color\":\"#000000\",\"starred\":true}", System.Text.Encoding.UTF8, "application/json");
request.Content = content;
var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());

Server Response

{
    "error": 0,
    "id": 3,
    "name": "New Channel",
    "description": "my new channel",
    "color": "#000000",
    "starred": true
}

POST https://s.pq.is/api/channel/:channelid/assign/:type/:itemid

Assign an Item to a Channel

An item can be assigned to any channel by sending a request with the channel id, item type (links, bio or qr) and item id.

Parameter Description

:channelid (required) Channel ID

:type (required) links or bio or qr

:itemid (required) Item ID

curl --location --request POST 'https://s.pq.is/api/channel/:channelid/assign/:type/:itemid' \
--header 'Authorization: Bearer YOURAPIKEY' \
--header 'Content-Type: application/json'

$curl = curl_init();
curl_setopt_array($curl, array(
    CURLOPT_URL => "https://s.pq.is/api/channel/:channelid/assign/:type/:itemid",
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_MAXREDIRS => 2,
    CURLOPT_TIMEOUT => 10,
    CURLOPT_FOLLOWLOCATION => true,
    CURLOPT_CUSTOMREQUEST => "POST",
    CURLOPT_HTTPHEADER => [
        "Authorization: Bearer YOURAPIKEY",
        "Content-Type: application/json",
    ],
));
$response = curl_exec($curl);
curl_close($curl);
echo $response;

var request = require('request');
var options = {
    'method': 'POST',
    'url': 'https://s.pq.is/api/channel/:channelid/assign/:type/:itemid',
    'headers': {
        'Authorization': 'Bearer YOURAPIKEY',
        'Content-Type': 'application/json'
    },
};
request(options, function (error, response) {
    if (error) throw new Error(error);
    console.log(response.body);
});

import requests
url = "https://s.pq.is/api/channel/:channelid/assign/:type/:itemid"
payload = {}
headers = {
    'Authorization': 'Bearer YOURAPIKEY',
    'Content-Type': 'application/json'
}
response = requests.request("POST", url, headers=headers, json=payload)
print(response.text)

var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Post, "https://s.pq.is/api/channel/:channelid/assign/:type/:itemid");
request.Headers.Add("Authorization", "Bearer YOURAPIKEY");
var content = new StringContent("{}", System.Text.Encoding.UTF8, "application/json");
request.Content = content;
var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());

Server Response

{
    "error": 0,
    "message": "Item successfully added to the channel."
}

PUT https://s.pq.is/api/channel/:id/update

Update Channel

To update a channel, you need to send a valid data in JSON via a PUT request. The data must be sent as the raw body of your request as shown below. The example below shows all the parameters you can send but you are not required to send all (See table for more info).

Parameter Description

name (optional) Channel name

description (optional) Channel description

color (optional) Channel badge color (HEX)

starred (optional) Star the channel or not (true or false)

curl --location --request PUT 'https://s.pq.is/api/channel/:id/update' \
--header 'Authorization: Bearer YOURAPIKEY' \
--header 'Content-Type: application/json' \
--data-raw '{
    "name": "Acme Corp",
    "description": "channel for items for Acme Corp",
    "color": "#FFFFFF",
    "starred": false
}'

$curl = curl_init();
curl_setopt_array($curl, array(
    CURLOPT_URL => "https://s.pq.is/api/channel/:id/update",
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_MAXREDIRS => 2,
    CURLOPT_TIMEOUT => 10,
    CURLOPT_FOLLOWLOCATION => true,
    CURLOPT_CUSTOMREQUEST => "PUT",
    CURLOPT_HTTPHEADER => [
        "Authorization: Bearer YOURAPIKEY",
        "Content-Type: application/json",
    ],
    CURLOPT_POSTFIELDS => '{
        "name": "Acme Corp",
        "description": "channel for items for Acme Corp",
        "color": "#FFFFFF",
        "starred": false
    }',
));
$response = curl_exec($curl);
curl_close($curl);
echo $response;

var request = require('request');
var options = {
    'method': 'PUT',
    'url': 'https://s.pq.is/api/channel/:id/update',
    'headers': {
        'Authorization': 'Bearer YOURAPIKEY',
        'Content-Type': 'application/json'
    },
    body: JSON.stringify({
    "name": "Acme Corp",
    "description": "channel for items for Acme Corp",
    "color": "#FFFFFF",
    "starred": false
}),
};
request(options, function (error, response) {
    if (error) throw new Error(error);
    console.log(response.body);
});

import requests
url = "https://s.pq.is/api/channel/:id/update"
payload = {
    "name": "Acme Corp",
    "description": "channel for items for Acme Corp",
    "color": "#FFFFFF",
    "starred": false
}
headers = {
    'Authorization': 'Bearer YOURAPIKEY',
    'Content-Type': 'application/json'
}
response = requests.request("PUT", url, headers=headers, json=payload)
print(response.text)

var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Put, "https://s.pq.is/api/channel/:id/update");
request.Headers.Add("Authorization", "Bearer YOURAPIKEY");
var content = new StringContent("{\"name\":\"Acme Corp\",\"description\":\"channel for items for Acme Corp\",\"color\":\"#FFFFFF\",\"starred\":false}", System.Text.Encoding.UTF8, "application/json");
request.Content = content;
var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());

Server Response

{
    "error": 0,
    "message": "Channel has been updated successfully."
}

DELETE https://s.pq.is/api/channel/:id/delete

Delete Channel

To delete a channel, you need to send a DELETE request. All items will be unassigned as well.

curl --location --request DELETE 'https://s.pq.is/api/channel/:id/delete' \
--header 'Authorization: Bearer YOURAPIKEY' \
--header 'Content-Type: application/json'

$curl = curl_init();
curl_setopt_array($curl, array(
    CURLOPT_URL => "https://s.pq.is/api/channel/:id/delete",
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_MAXREDIRS => 2,
    CURLOPT_TIMEOUT => 10,
    CURLOPT_FOLLOWLOCATION => true,
    CURLOPT_CUSTOMREQUEST => "DELETE",
    CURLOPT_HTTPHEADER => [
        "Authorization: Bearer YOURAPIKEY",
        "Content-Type: application/json",
    ],
));
$response = curl_exec($curl);
curl_close($curl);
echo $response;

var request = require('request');
var options = {
    'method': 'DELETE',
    'url': 'https://s.pq.is/api/channel/:id/delete',
    'headers': {
        'Authorization': 'Bearer YOURAPIKEY',
        'Content-Type': 'application/json'
    },
};
request(options, function (error, response) {
    if (error) throw new Error(error);
    console.log(response.body);
});

import requests
url = "https://s.pq.is/api/channel/:id/delete"
payload = {}
headers = {
    'Authorization': 'Bearer YOURAPIKEY',
    'Content-Type': 'application/json'
}
response = requests.request("DELETE", url, headers=headers, json=payload)
print(response.text)

var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Delete, "https://s.pq.is/api/channel/:id/delete");
request.Headers.Add("Authorization", "Bearer YOURAPIKEY");
var content = new StringContent("{}", System.Text.Encoding.UTF8, "application/json");
request.Content = content;
var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());

Server Response

{
    "error": 0,
    "message": "Channel has been deleted successfully."
}

Custom Splash

GET https://s.pq.is/api/splash?limit=2&page=1

List Custom Splash

To get custom splash pages via the API, you can use this endpoint. You can also filter data (See table for more info).

Parameter Description

limit (optional) Per page data result

page (optional) Current page request

curl --location --request GET 'https://s.pq.is/api/splash?limit=2&page=1' \
--header 'Authorization: Bearer YOURAPIKEY' \
--header 'Content-Type: application/json'

$curl = curl_init();
curl_setopt_array($curl, array(
    CURLOPT_URL => "https://s.pq.is/api/splash?limit=2&page=1",
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_MAXREDIRS => 2,
    CURLOPT_TIMEOUT => 10,
    CURLOPT_FOLLOWLOCATION => true,
    CURLOPT_CUSTOMREQUEST => "GET",
    CURLOPT_HTTPHEADER => [
        "Authorization: Bearer YOURAPIKEY",
        "Content-Type: application/json",
    ],
));
$response = curl_exec($curl);
curl_close($curl);
echo $response;

var request = require('request');
var options = {
    'method': 'GET',
    'url': 'https://s.pq.is/api/splash?limit=2&page=1',
    'headers': {
        'Authorization': 'Bearer YOURAPIKEY',
        'Content-Type': 'application/json'
    },
};
request(options, function (error, response) {
    if (error) throw new Error(error);
    console.log(response.body);
});

import requests
url = "https://s.pq.is/api/splash?limit=2&page=1"
payload = {}
headers = {
    'Authorization': 'Bearer YOURAPIKEY',
    'Content-Type': 'application/json'
}
response = requests.request("GET", url, headers=headers, json=payload)
print(response.text)

var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Get, "https://s.pq.is/api/splash?limit=2&page=1");
request.Headers.Add("Authorization", "Bearer YOURAPIKEY");
var content = new StringContent("{}", System.Text.Encoding.UTF8, "application/json");
request.Content = content;
var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());

Server Response

{
    "error": "0",
    "data": {
        "result": 2,
        "perpage": 2,
        "currentpage": 1,
        "nextpage": 1,
        "maxpage": 1,
        "splash": [
            {
                "id": 1,
                "name": "Product 1 Promo",
                "date": "2020-11-10 18:00:00"
            },
            {
                "id": 2,
                "name": "Product 2 Promo",
                "date": "2020-11-10 18:10:00"
            }
        ]
    }
}

Files

GET https://s.pq.is/api/files?limit=2&page=1

List Files

Get all of your files. You can also search by name.

Parameter Description

name (optional) Search for a file by name

limit (optional) Per page data result

page (optional) Current page request

curl --location --request GET 'https://s.pq.is/api/files?limit=2&page=1' \
--header 'Authorization: Bearer YOURAPIKEY' \
--header 'Content-Type: application/json'

$curl = curl_init();
curl_setopt_array($curl, array(
    CURLOPT_URL => "https://s.pq.is/api/files?limit=2&page=1",
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_MAXREDIRS => 2,
    CURLOPT_TIMEOUT => 10,
    CURLOPT_FOLLOWLOCATION => true,
    CURLOPT_CUSTOMREQUEST => "GET",
    CURLOPT_HTTPHEADER => [
        "Authorization: Bearer YOURAPIKEY",
        "Content-Type: application/json",
    ],
));
$response = curl_exec($curl);
curl_close($curl);
echo $response;

var request = require('request');
var options = {
    'method': 'GET',
    'url': 'https://s.pq.is/api/files?limit=2&page=1',
    'headers': {
        'Authorization': 'Bearer YOURAPIKEY',
        'Content-Type': 'application/json'
    },
};
request(options, function (error, response) {
    if (error) throw new Error(error);
    console.log(response.body);
});

import requests
url = "https://s.pq.is/api/files?limit=2&page=1"
payload = {}
headers = {
    'Authorization': 'Bearer YOURAPIKEY',
    'Content-Type': 'application/json'
}
response = requests.request("GET", url, headers=headers, json=payload)
print(response.text)

var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Get, "https://s.pq.is/api/files?limit=2&page=1");
request.Headers.Add("Authorization", "Bearer YOURAPIKEY");
var content = new StringContent("{}", System.Text.Encoding.UTF8, "application/json");
request.Content = content;
var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());

Server Response

{
    "error": 0,
    "result": 3,
    "perpage": 15,
    "currentpage": 1,
    "nextpage": null,
    "maxpage": 1,
    "list": [
        {
            "id": 1,
            "name": "My Photo",
            "downloads": 10,
            "shorturl": "https:\/\/s.pq.is\/YBWeB",
            "date": "2022-08-09 17:00:00"
        },
        {
            "id": 2,
            "name": "My Documents",
            "downloads": 15,
            "shorturl": "https:\/\/s.pq.is\/Xvzml",
            "date": "2022-08-10 17:01:00"
        },
        {
            "id": 3,
            "name": "My Files",
            "downloads": 5,
            "shorturl": "https:\/\/s.pq.is\/SEQEK",
            "date": "2022-08-11 19:01:00"
        }
    ]
}

POST https://s.pq.is/api/files/upload/:filename?name=My+File

Upload a file

Upload a file by sending the binary data as the post body. You need to send the file name including the extension instead of :filename in the url (e.g. brandkit.zip). You can set options by sending the following parameters.

Parameter Description

name (optional) File name

custom (optional) Custom alias instead of random alias.

domain (optional) Custom Domain

password (optional) Password protection

expiry (optional) Expiration for the download example 2021-09-28

maxdownloads (optional) Maximum number of downloads

curl --location --request POST 'https://s.pq.is/api/files/upload/:filename?name=My+File' \
--header 'Authorization: Bearer YOURAPIKEY' \
--header 'Content-Type: application/json' \
--data-raw '"BINARY DATA"'

$curl = curl_init();
curl_setopt_array($curl, array(
    CURLOPT_URL => "https://s.pq.is/api/files/upload/:filename?name=My+File",
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_MAXREDIRS => 2,
    CURLOPT_TIMEOUT => 10,
    CURLOPT_FOLLOWLOCATION => true,
    CURLOPT_CUSTOMREQUEST => "POST",
    CURLOPT_HTTPHEADER => [
        "Authorization: Bearer YOURAPIKEY",
        "Content-Type: application/json",
    ],
    CURLOPT_POSTFIELDS => '"BINARY DATA"',
));
$response = curl_exec($curl);
curl_close($curl);
echo $response;

var request = require('request');
var options = {
    'method': 'POST',
    'url': 'https://s.pq.is/api/files/upload/:filename?name=My+File',
    'headers': {
        'Authorization': 'Bearer YOURAPIKEY',
        'Content-Type': 'application/json'
    },
    body: JSON.stringify("BINARY DATA"),
};
request(options, function (error, response) {
    if (error) throw new Error(error);
    console.log(response.body);
});

import requests
url = "https://s.pq.is/api/files/upload/:filename?name=My+File"
payload = "BINARY DATA"
headers = {
    'Authorization': 'Bearer YOURAPIKEY',
    'Content-Type': 'application/json'
}
response = requests.request("POST", url, headers=headers, json=payload)
print(response.text)

var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Post, "https://s.pq.is/api/files/upload/:filename?name=My+File");
request.Headers.Add("Authorization", "Bearer YOURAPIKEY");
var content = new StringContent("\"BINARY DATA\"", System.Text.Encoding.UTF8, "application/json");
request.Content = content;
var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());

Server Response

{
    "error": 0,
    "id": 1,
    "shorturl": "https:\/\/s.pq.is\/lkefT"
}

Links

GET https://s.pq.is/api/urls?limit=2&page=1&order=date

List Links

To get your links via the API, you can use this endpoint. You can also filter data (See table for more info).

Parameter Description

limit (optional) Per page data result

page (optional) Current page request

order (optional) Sort data between date or click

short (optional) Search using the short url. Note that when you use the short parameter, all other parameters are ignored and if there is a match a Single Link response will be returned.

q (optional) Search for links using a keyword

curl --location --request GET 'https://s.pq.is/api/urls?limit=2&page=1&order=date' \
--header 'Authorization: Bearer YOURAPIKEY' \
--header 'Content-Type: application/json'

$curl = curl_init();
curl_setopt_array($curl, array(
    CURLOPT_URL => "https://s.pq.is/api/urls?limit=2&page=1&order=date",
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_MAXREDIRS => 2,
    CURLOPT_TIMEOUT => 10,
    CURLOPT_FOLLOWLOCATION => true,
    CURLOPT_CUSTOMREQUEST => "GET",
    CURLOPT_HTTPHEADER => [
        "Authorization: Bearer YOURAPIKEY",
        "Content-Type: application/json",
    ],
));
$response = curl_exec($curl);
curl_close($curl);
echo $response;

var request = require('request');
var options = {
    'method': 'GET',
    'url': 'https://s.pq.is/api/urls?limit=2&page=1&order=date',
    'headers': {
        'Authorization': 'Bearer YOURAPIKEY',
        'Content-Type': 'application/json'
    },
};
request(options, function (error, response) {
    if (error) throw new Error(error);
    console.log(response.body);
});

import requests
url = "https://s.pq.is/api/urls?limit=2&page=1&order=date"
payload = {}
headers = {
    'Authorization': 'Bearer YOURAPIKEY',
    'Content-Type': 'application/json'
}
response = requests.request("GET", url, headers=headers, json=payload)
print(response.text)

var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Get, "https://s.pq.is/api/urls?limit=2&page=1&order=date");
request.Headers.Add("Authorization", "Bearer YOURAPIKEY");
var content = new StringContent("{}", System.Text.Encoding.UTF8, "application/json");
request.Content = content;
var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());

Server Response

{
    "error": "0",
    "data": {
        "result": 2,
        "perpage": 2,
        "currentpage": 1,
        "nextpage": 1,
        "maxpage": 1,
        "urls": [
            {
                "id": 2,
                "alias": "google",
                "shorturl": "https:\/\/s.pq.is\/google",
                "longurl": "https:\/\/google.com",
                "clicks": 0,
                "title": "Google",
                "description": "",
                "date": "2020-11-10 18:01:43"
            },
            {
                "id": 1,
                "alias": "googlecanada",
                "shorturl": "https:\/\/s.pq.is\/googlecanada",
                "longurl": "https:\/\/google.ca",
                "clicks": 0,
                "title": "Google Canada",
                "description": "",
                "date": "2020-11-10 18:00:25"
            }
        ]
    }
}

GET https://s.pq.is/api/url/:id

Get a Single Link

To get details for a single link via the API, you can use this endpoint.

curl --location --request GET 'https://s.pq.is/api/url/:id' \
--header 'Authorization: Bearer YOURAPIKEY' \
--header 'Content-Type: application/json'

$curl = curl_init();
curl_setopt_array($curl, array(
    CURLOPT_URL => "https://s.pq.is/api/url/:id",
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_MAXREDIRS => 2,
    CURLOPT_TIMEOUT => 10,
    CURLOPT_FOLLOWLOCATION => true,
    CURLOPT_CUSTOMREQUEST => "GET",
    CURLOPT_HTTPHEADER => [
        "Authorization: Bearer YOURAPIKEY",
        "Content-Type: application/json",
    ],
));
$response = curl_exec($curl);
curl_close($curl);
echo $response;

var request = require('request');
var options = {
    'method': 'GET',
    'url': 'https://s.pq.is/api/url/:id',
    'headers': {
        'Authorization': 'Bearer YOURAPIKEY',
        'Content-Type': 'application/json'
    },
};
request(options, function (error, response) {
    if (error) throw new Error(error);
    console.log(response.body);
});

import requests
url = "https://s.pq.is/api/url/:id"
payload = {}
headers = {
    'Authorization': 'Bearer YOURAPIKEY',
    'Content-Type': 'application/json'
}
response = requests.request("GET", url, headers=headers, json=payload)
print(response.text)

var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Get, "https://s.pq.is/api/url/:id");
request.Headers.Add("Authorization", "Bearer YOURAPIKEY");
var content = new StringContent("{}", System.Text.Encoding.UTF8, "application/json");
request.Content = content;
var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());

Server Response

{
    "error": 0,
    "id": 1,
    "details": {
        "id": 1,
        "shorturl": "https:\/\/s.pq.is\/googlecanada",
        "longurl": "https:\/\/google.com",
        "title": "Google",
        "description": "",
        "location": {
            "canada": "https:\/\/google.ca",
            "united states": "https:\/\/google.us"
        },
        "device": {
            "iphone": "https:\/\/google.com",
            "android": "https:\/\/google.com"
        },
        "expiry": null,
        "date": "2020-11-10 18:01:43"
    },
    "data": {
        "clicks": 0,
        "uniqueClicks": 0,
        "topCountries": 0,
        "topReferrers": 0,
        "topBrowsers": 0,
        "topOs": 0,
        "socialCount": {
            "facebook": 0,
            "twitter": 0,
            "google": 0
        }
    }
}

POST https://s.pq.is/api/url/add

Shorten a Link

To shorten a link, you need to send a valid data in JSON via a POST request. The data must be sent as the raw body of your request as shown below. The example below shows all the parameters you can send but you are not required to send all (See table for more info).

Parameter Description

url (required) Long URL to shorten.

custom (optional) Custom alias instead of random alias.

type (optional) Redirection type [direct, frame, splash], only id for custom splash page or overlay-id for cta pages

password (optional) Password protection

domain (optional) Custom Domain

expiry (optional) Expiration for the link example 2021-09-28 23:11:16

geotarget (optional) Geo targeting data

devicetarget (optional) Device targeting data

languagetarget (optional) Language targeting data

metatitle (optional) Meta title

metadescription (optional) Meta description

metaimage (optional) Link to a jpg or png image

description (optional) Note or description

pixels (optional) Array of pixel ids

channel (optional) Channel ID

campaign (optional) Campaign ID

deeplink (optional) Object containing app store links. When using this, it is important to set device targeting as well. (New) You can now set the parameter "auto" to true to automatically generate the deep links from provided long link.

status (optional) public or private (default)

curl --location --request POST 'https://s.pq.is/api/url/add' \
--header 'Authorization: Bearer YOURAPIKEY' \
--header 'Content-Type: application/json' \
--data-raw '{
    "url": "https:\/\/google.com",
    "status": "private",
    "custom": "google",
    "password": "mypass",
    "expiry": "2020-11-11 12:00:00",
    "type": "splash",
    "metatitle": "Not Google",
    "metadescription": "Not Google description",
    "metaimage": "https:\/\/www.mozilla.org\/media\/protocol\/img\/logos\/firefox\/browser\/og.4ad05d4125a5.png",
    "description": "For facebook",
    "pixels": [
        1,
        2,
        3,
        4
    ],
    "channel": 1,
    "campaign": 1,
    "deeplink": {
        "auto": true,
        "apple": "https:\/\/apps.apple.com\/us\/app\/google\/id284815942",
        "google": "https:\/\/play.google.com\/store\/apps\/details?id=com.google.android.googlequicksearchbox&hl=en_CA&gl=US"
    },
    "geotarget": [
        {
            "location": "Canada",
            "link": "https:\/\/google.ca"
        },
        {
            "location": "United States",
            "link": "https:\/\/google.us"
        }
    ],
    "devicetarget": [
        {
            "device": "iPhone",
            "link": "https:\/\/google.com"
        },
        {
            "device": "Android",
            "link": "https:\/\/google.com"
        }
    ],
    "languagetarget": [
        {
            "language": "en",
            "link": "https:\/\/google.com"
        },
        {
            "language": "fr",
            "link": "https:\/\/google.ca"
        }
    ],
    "parameters": [
        {
            "name": "aff",
            "value": "3"
        },
        {
            "device": "gtm_source",
            "link": "api"
        }
    ]
}'

$curl = curl_init();
curl_setopt_array($curl, array(
    CURLOPT_URL => "https://s.pq.is/api/url/add",
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_MAXREDIRS => 2,
    CURLOPT_TIMEOUT => 10,
    CURLOPT_FOLLOWLOCATION => true,
    CURLOPT_CUSTOMREQUEST => "POST",
    CURLOPT_HTTPHEADER => [
        "Authorization: Bearer YOURAPIKEY",
        "Content-Type: application/json",
    ],
    CURLOPT_POSTFIELDS => '{
        "url": "https:\/\/google.com",
        "status": "private",
        "custom": "google",
        "password": "mypass",
        "expiry": "2020-11-11 12:00:00",
        "type": "splash",
        "metatitle": "Not Google",
        "metadescription": "Not Google description",
        "metaimage": "https:\/\/www.mozilla.org\/media\/protocol\/img\/logos\/firefox\/browser\/og.4ad05d4125a5.png",
        "description": "For facebook",
        "pixels": [
            1,
            2,
            3,
            4
        ],
        "channel": 1,
        "campaign": 1,
        "deeplink": {
            "auto": true,
            "apple": "https:\/\/apps.apple.com\/us\/app\/google\/id284815942",
            "google": "https:\/\/play.google.com\/store\/apps\/details?id=com.google.android.googlequicksearchbox&hl=en_CA&gl=US"
        },
        "geotarget": [
            {
                "location": "Canada",
                "link": "https:\/\/google.ca"
            },
            {
                "location": "United States",
                "link": "https:\/\/google.us"
            }
        ],
        "devicetarget": [
            {
                "device": "iPhone",
                "link": "https:\/\/google.com"
            },
            {
                "device": "Android",
                "link": "https:\/\/google.com"
            }
        ],
        "languagetarget": [
            {
                "language": "en",
                "link": "https:\/\/google.com"
            },
            {
                "language": "fr",
                "link": "https:\/\/google.ca"
            }
        ],
        "parameters": [
            {
                "name": "aff",
                "value": "3"
            },
            {
                "device": "gtm_source",
                "link": "api"
            }
        ]
    }',
));
$response = curl_exec($curl);
curl_close($curl);
echo $response;

var request = require('request');
var options = {
    'method': 'POST',
    'url': 'https://s.pq.is/api/url/add',
    'headers': {
        'Authorization': 'Bearer YOURAPIKEY',
        'Content-Type': 'application/json'
    },
    body: JSON.stringify({
    "url": "https:\/\/google.com",
    "status": "private",
    "custom": "google",
    "password": "mypass",
    "expiry": "2020-11-11 12:00:00",
    "type": "splash",
    "metatitle": "Not Google",
    "metadescription": "Not Google description",
    "metaimage": "https:\/\/www.mozilla.org\/media\/protocol\/img\/logos\/firefox\/browser\/og.4ad05d4125a5.png",
    "description": "For facebook",
    "pixels": [
        1,
        2,
        3,
        4
    ],
    "channel": 1,
    "campaign": 1,
    "deeplink": {
        "auto": true,
        "apple": "https:\/\/apps.apple.com\/us\/app\/google\/id284815942",
        "google": "https:\/\/play.google.com\/store\/apps\/details?id=com.google.android.googlequicksearchbox&hl=en_CA&gl=US"
    },
    "geotarget": [
        {
            "location": "Canada",
            "link": "https:\/\/google.ca"
        },
        {
            "location": "United States",
            "link": "https:\/\/google.us"
        }
    ],
    "devicetarget": [
        {
            "device": "iPhone",
            "link": "https:\/\/google.com"
        },
        {
            "device": "Android",
            "link": "https:\/\/google.com"
        }
    ],
    "languagetarget": [
        {
            "language": "en",
            "link": "https:\/\/google.com"
        },
        {
            "language": "fr",
            "link": "https:\/\/google.ca"
        }
    ],
    "parameters": [
        {
            "name": "aff",
            "value": "3"
        },
        {
            "device": "gtm_source",
            "link": "api"
        }
    ]
}),
};
request(options, function (error, response) {
    if (error) throw new Error(error);
    console.log(response.body);
});

import requests
url = "https://s.pq.is/api/url/add"
payload = {
    "url": "https://google.com",
    "status": "private",
    "custom": "google",
    "password": "mypass",
    "expiry": "2020-11-11 12:00:00",
    "type": "splash",
    "metatitle": "Not Google",
    "metadescription": "Not Google description",
    "metaimage": "https://www.mozilla.org/media/protocol/img/logos/firefox/browser/og.4ad05d4125a5.png",
    "description": "For facebook",
    "pixels": [
        1,
        2,
        3,
        4
    ],
    "channel": 1,
    "campaign": 1,
    "deeplink": {
        "auto": true,
        "apple": "https://apps.apple.com/us/app/google/id284815942",
        "google": "https://play.google.com/store/apps/details?id=com.google.android.googlequicksearchbox&hl=en_CA&gl=US"
    },
    "geotarget": [
        {
            "location": "Canada",
            "link": "https://google.ca"
        },
        {
            "location": "United States",
            "link": "https://google.us"
        }
    ],
    "devicetarget": [
        {
            "device": "iPhone",
            "link": "https://google.com"
        },
        {
            "device": "Android",
            "link": "https://google.com"
        }
    ],
    "languagetarget": [
        {
            "language": "en",
            "link": "https://google.com"
        },
        {
            "language": "fr",
            "link": "https://google.ca"
        }
    ],
    "parameters": [
        {
            "name": "aff",
            "value": "3"
        },
        {
            "device": "gtm_source",
            "link": "api"
        }
    ]
}
headers = {
    'Authorization': 'Bearer YOURAPIKEY',
    'Content-Type': 'application/json'
}
response = requests.request("POST", url, headers=headers, json=payload)
print(response.text)

var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Post, "https://s.pq.is/api/url/add");
request.Headers.Add("Authorization", "Bearer YOURAPIKEY");
var content = new StringContent("{\"url\":\"https:\\/\\/google.com\",\"status\":\"private\",\"custom\":\"google\",\"password\":\"mypass\",\"expiry\":\"2020-11-11 12:00:00\",\"type\":\"splash\",\"metatitle\":\"Not Google\",\"metadescription\":\"Not Google description\",\"metaimage\":\"https:\\/\\/www.mozilla.org\\/media\\/protocol\\/img\\/logos\\/firefox\\/browser\\/og.4ad05d4125a5.png\",\"description\":\"For facebook\",\"pixels\":[1,2,3,4],\"channel\":1,\"campaign\":1,\"deeplink\":{\"auto\":true,\"apple\":\"https:\\/\\/apps.apple.com\\/us\\/app\\/google\\/id284815942\",\"google\":\"https:\\/\\/play.google.com\\/store\\/apps\\/details?id=com.google.android.googlequicksearchbox&hl=en_CA&gl=US\"},\"geotarget\":[{\"location\":\"Canada\",\"link\":\"https:\\/\\/google.ca\"},{\"location\":\"United States\",\"link\":\"https:\\/\\/google.us\"}],\"devicetarget\":[{\"device\":\"iPhone\",\"link\":\"https:\\/\\/google.com\"},{\"device\":\"Android\",\"link\":\"https:\\/\\/google.com\"}],\"languagetarget\":[{\"language\":\"en\",\"link\":\"https:\\/\\/google.com\"},{\"language\":\"fr\",\"link\":\"https:\\/\\/google.ca\"}],\"parameters\":[{\"name\":\"aff\",\"value\":\"3\"},{\"device\":\"gtm_source\",\"link\":\"api\"}]}", System.Text.Encoding.UTF8, "application/json");
request.Content = content;
var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());

Server Response

{
    "error": 0,
    "id": 3,
    "shorturl": "https:\/\/s.pq.is\/google"
}

PUT https://s.pq.is/api/url/:id/update

Update Link

To update a link, you need to send a valid data in JSON via a PUT request. The data must be sent as the raw body of your request as shown below. The example below shows all the parameters you can send but you are not required to send all (See table for more info).

Parameter Description

url (required) Long URL to shorten.

custom (optional) Custom alias instead of random alias.

type (optional) Redirection type [direct, frame, splash]

password (optional) Password protection

domain (optional) Custom Domain

expiry (optional) Expiration for the link example 2021-09-28 23:11:16

geotarget (optional) Geo targeting data

devicetarget (optional) Device targeting data

languagetarget (optional) Language targeting data

metatitle (optional) Meta title

metadescription (optional) Meta description

metaimage (optional) Link to a jpg or png image

pixels (optional) Array of pixel ids

channel (optional) Channel ID

campaign (optional) Campaign ID

deeplink (optional) Object containing app store links. When using this, it is important to set device targeting as well.

curl --location --request PUT 'https://s.pq.is/api/url/:id/update' \
--header 'Authorization: Bearer YOURAPIKEY' \
--header 'Content-Type: application/json' \
--data-raw '{
    "url": "https:\/\/google.com",
    "custom": "google",
    "password": "mypass",
    "expiry": "2020-11-11 12:00:00",
    "type": "splash",
    "pixels": [
        1,
        2,
        3,
        4
    ],
    "channel": 1,
    "deeplink": {
        "apple": "https:\/\/apps.apple.com\/us\/app\/google\/id284815942",
        "google": "https:\/\/play.google.com\/store\/apps\/details?id=com.google.android.googlequicksearchbox&hl=en_CA&gl=US"
    },
    "geotarget": [
        {
            "location": "Canada",
            "link": "https:\/\/google.ca"
        },
        {
            "location": "United States",
            "link": "https:\/\/google.us"
        }
    ],
    "devicetarget": [
        {
            "device": "iPhone",
            "link": "https:\/\/google.com"
        },
        {
            "device": "Android",
            "link": "https:\/\/google.com"
        }
    ],
    "parameters": [
        {
            "name": "aff",
            "value": "3"
        },
        {
            "device": "gtm_source",
            "link": "api"
        }
    ]
}'

$curl = curl_init();
curl_setopt_array($curl, array(
    CURLOPT_URL => "https://s.pq.is/api/url/:id/update",
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_MAXREDIRS => 2,
    CURLOPT_TIMEOUT => 10,
    CURLOPT_FOLLOWLOCATION => true,
    CURLOPT_CUSTOMREQUEST => "PUT",
    CURLOPT_HTTPHEADER => [
        "Authorization: Bearer YOURAPIKEY",
        "Content-Type: application/json",
    ],
    CURLOPT_POSTFIELDS => '{
        "url": "https:\/\/google.com",
        "custom": "google",
        "password": "mypass",
        "expiry": "2020-11-11 12:00:00",
        "type": "splash",
        "pixels": [
            1,
            2,
            3,
            4
        ],
        "channel": 1,
        "deeplink": {
            "apple": "https:\/\/apps.apple.com\/us\/app\/google\/id284815942",
            "google": "https:\/\/play.google.com\/store\/apps\/details?id=com.google.android.googlequicksearchbox&hl=en_CA&gl=US"
        },
        "geotarget": [
            {
                "location": "Canada",
                "link": "https:\/\/google.ca"
            },
            {
                "location": "United States",
                "link": "https:\/\/google.us"
            }
        ],
        "devicetarget": [
            {
                "device": "iPhone",
                "link": "https:\/\/google.com"
            },
            {
                "device": "Android",
                "link": "https:\/\/google.com"
            }
        ],
        "parameters": [
            {
                "name": "aff",
                "value": "3"
            },
            {
                "device": "gtm_source",
                "link": "api"
            }
        ]
    }',
));
$response = curl_exec($curl);
curl_close($curl);
echo $response;

var request = require('request');
var options = {
    'method': 'PUT',
    'url': 'https://s.pq.is/api/url/:id/update',
    'headers': {
        'Authorization': 'Bearer YOURAPIKEY',
        'Content-Type': 'application/json'
    },
    body: JSON.stringify({
    "url": "https:\/\/google.com",
    "custom": "google",
    "password": "mypass",
    "expiry": "2020-11-11 12:00:00",
    "type": "splash",
    "pixels": [
        1,
        2,
        3,
        4
    ],
    "channel": 1,
    "deeplink": {
        "apple": "https:\/\/apps.apple.com\/us\/app\/google\/id284815942",
        "google": "https:\/\/play.google.com\/store\/apps\/details?id=com.google.android.googlequicksearchbox&hl=en_CA&gl=US"
    },
    "geotarget": [
        {
            "location": "Canada",
            "link": "https:\/\/google.ca"
        },
        {
            "location": "United States",
            "link": "https:\/\/google.us"
        }
    ],
    "devicetarget": [
        {
            "device": "iPhone",
            "link": "https:\/\/google.com"
        },
        {
            "device": "Android",
            "link": "https:\/\/google.com"
        }
    ],
    "parameters": [
        {
            "name": "aff",
            "value": "3"
        },
        {
            "device": "gtm_source",
            "link": "api"
        }
    ]
}),
};
request(options, function (error, response) {
    if (error) throw new Error(error);
    console.log(response.body);
});

import requests
url = "https://s.pq.is/api/url/:id/update"
payload = {
    "url": "https://google.com",
    "custom": "google",
    "password": "mypass",
    "expiry": "2020-11-11 12:00:00",
    "type": "splash",
    "pixels": [
        1,
        2,
        3,
        4
    ],
    "channel": 1,
    "deeplink": {
        "apple": "https://apps.apple.com/us/app/google/id284815942",
        "google": "https://play.google.com/store/apps/details?id=com.google.android.googlequicksearchbox&hl=en_CA&gl=US"
    },
    "geotarget": [
        {
            "location": "Canada",
            "link": "https://google.ca"
        },
        {
            "location": "United States",
            "link": "https://google.us"
        }
    ],
    "devicetarget": [
        {
            "device": "iPhone",
            "link": "https://google.com"
        },
        {
            "device": "Android",
            "link": "https://google.com"
        }
    ],
    "parameters": [
        {
            "name": "aff",
            "value": "3"
        },
        {
            "device": "gtm_source",
            "link": "api"
        }
    ]
}
headers = {
    'Authorization': 'Bearer YOURAPIKEY',
    'Content-Type': 'application/json'
}
response = requests.request("PUT", url, headers=headers, json=payload)
print(response.text)

var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Put, "https://s.pq.is/api/url/:id/update");
request.Headers.Add("Authorization", "Bearer YOURAPIKEY");
var content = new StringContent("{\"url\":\"https:\\/\\/google.com\",\"custom\":\"google\",\"password\":\"mypass\",\"expiry\":\"2020-11-11 12:00:00\",\"type\":\"splash\",\"pixels\":[1,2,3,4],\"channel\":1,\"deeplink\":{\"apple\":\"https:\\/\\/apps.apple.com\\/us\\/app\\/google\\/id284815942\",\"google\":\"https:\\/\\/play.google.com\\/store\\/apps\\/details?id=com.google.android.googlequicksearchbox&hl=en_CA&gl=US\"},\"geotarget\":[{\"location\":\"Canada\",\"link\":\"https:\\/\\/google.ca\"},{\"location\":\"United States\",\"link\":\"https:\\/\\/google.us\"}],\"devicetarget\":[{\"device\":\"iPhone\",\"link\":\"https:\\/\\/google.com\"},{\"device\":\"Android\",\"link\":\"https:\\/\\/google.com\"}],\"parameters\":[{\"name\":\"aff\",\"value\":\"3\"},{\"device\":\"gtm_source\",\"link\":\"api\"}]}", System.Text.Encoding.UTF8, "application/json");
request.Content = content;
var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());

Server Response

{
    "error": 0,
    "id": 3,
    "short": "https:\/\/s.pq.is\/google"
}

DELETE https://s.pq.is/api/url/:id/delete

Delete a Link

To delete a link, you need to send a DELETE request.

curl --location --request DELETE 'https://s.pq.is/api/url/:id/delete' \
--header 'Authorization: Bearer YOURAPIKEY' \
--header 'Content-Type: application/json'

$curl = curl_init();
curl_setopt_array($curl, array(
    CURLOPT_URL => "https://s.pq.is/api/url/:id/delete",
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_MAXREDIRS => 2,
    CURLOPT_TIMEOUT => 10,
    CURLOPT_FOLLOWLOCATION => true,
    CURLOPT_CUSTOMREQUEST => "DELETE",
    CURLOPT_HTTPHEADER => [
        "Authorization: Bearer YOURAPIKEY",
        "Content-Type: application/json",
    ],
));
$response = curl_exec($curl);
curl_close($curl);
echo $response;

var request = require('request');
var options = {
    'method': 'DELETE',
    'url': 'https://s.pq.is/api/url/:id/delete',
    'headers': {
        'Authorization': 'Bearer YOURAPIKEY',
        'Content-Type': 'application/json'
    },
};
request(options, function (error, response) {
    if (error) throw new Error(error);
    console.log(response.body);
});

import requests
url = "https://s.pq.is/api/url/:id/delete"
payload = {}
headers = {
    'Authorization': 'Bearer YOURAPIKEY',
    'Content-Type': 'application/json'
}
response = requests.request("DELETE", url, headers=headers, json=payload)
print(response.text)

var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Delete, "https://s.pq.is/api/url/:id/delete");
request.Headers.Add("Authorization", "Bearer YOURAPIKEY");
var content = new StringContent("{}", System.Text.Encoding.UTF8, "application/json");
request.Content = content;
var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());

Server Response

{
    "error": 0,
    "message": "Link has been deleted successfully"
}

Pixels

GET https://s.pq.is/api/pixels?limit=2&page=1

List Pixels

To get your pixels codes via the API, you can use this endpoint. You can also filter data (See table for more info).

Parameter Description

limit (optional) Per page data result

page (optional) Current page request

curl --location --request GET 'https://s.pq.is/api/pixels?limit=2&page=1' \
--header 'Authorization: Bearer YOURAPIKEY' \
--header 'Content-Type: application/json'

$curl = curl_init();
curl_setopt_array($curl, array(
    CURLOPT_URL => "https://s.pq.is/api/pixels?limit=2&page=1",
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_MAXREDIRS => 2,
    CURLOPT_TIMEOUT => 10,
    CURLOPT_FOLLOWLOCATION => true,
    CURLOPT_CUSTOMREQUEST => "GET",
    CURLOPT_HTTPHEADER => [
        "Authorization: Bearer YOURAPIKEY",
        "Content-Type: application/json",
    ],
));
$response = curl_exec($curl);
curl_close($curl);
echo $response;

var request = require('request');
var options = {
    'method': 'GET',
    'url': 'https://s.pq.is/api/pixels?limit=2&page=1',
    'headers': {
        'Authorization': 'Bearer YOURAPIKEY',
        'Content-Type': 'application/json'
    },
};
request(options, function (error, response) {
    if (error) throw new Error(error);
    console.log(response.body);
});

import requests
url = "https://s.pq.is/api/pixels?limit=2&page=1"
payload = {}
headers = {
    'Authorization': 'Bearer YOURAPIKEY',
    'Content-Type': 'application/json'
}
response = requests.request("GET", url, headers=headers, json=payload)
print(response.text)

var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Get, "https://s.pq.is/api/pixels?limit=2&page=1");
request.Headers.Add("Authorization", "Bearer YOURAPIKEY");
var content = new StringContent("{}", System.Text.Encoding.UTF8, "application/json");
request.Content = content;
var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());

Server Response

{
    "error": "0",
    "data": {
        "result": 2,
        "perpage": 2,
        "currentpage": 1,
        "nextpage": 1,
        "maxpage": 1,
        "pixels": [
            {
                "id": 1,
                "type": "gtmpixel",
                "name": "GTM Pixel",
                "tag": "GA-123456789",
                "date": "2020-11-10 18:00:00"
            },
            {
                "id": 2,
                "type": "twitterpixel",
                "name": "Twitter Pixel",
                "tag": "1234567",
                "date": "2020-11-10 18:10:00"
            }
        ]
    }
}

POST https://s.pq.is/api/pixel/add

Create a Pixel

A pixel can be created using this endpoint. You need to send the pixel type and the tag.

Parameter Description

name (required) Custom name for your pixel

tag (required) The tag for the pixel

curl --location --request POST 'https://s.pq.is/api/pixel/add' \
--header 'Authorization: Bearer YOURAPIKEY' \
--header 'Content-Type: application/json' \
--data-raw '{
    "type": "gtmpixel",
    "name": "My GTM",
    "tag": "GTM-ABCDE"
}'

$curl = curl_init();
curl_setopt_array($curl, array(
    CURLOPT_URL => "https://s.pq.is/api/pixel/add",
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_MAXREDIRS => 2,
    CURLOPT_TIMEOUT => 10,
    CURLOPT_FOLLOWLOCATION => true,
    CURLOPT_CUSTOMREQUEST => "POST",
    CURLOPT_HTTPHEADER => [
        "Authorization: Bearer YOURAPIKEY",
        "Content-Type: application/json",
    ],
    CURLOPT_POSTFIELDS => '{
        "type": "gtmpixel",
        "name": "My GTM",
        "tag": "GTM-ABCDE"
    }',
));
$response = curl_exec($curl);
curl_close($curl);
echo $response;

var request = require('request');
var options = {
    'method': 'POST',
    'url': 'https://s.pq.is/api/pixel/add',
    'headers': {
        'Authorization': 'Bearer YOURAPIKEY',
        'Content-Type': 'application/json'
    },
    body: JSON.stringify({
    "type": "gtmpixel",
    "name": "My GTM",
    "tag": "GTM-ABCDE"
}),
};
request(options, function (error, response) {
    if (error) throw new Error(error);
    console.log(response.body);
});

import requests
url = "https://s.pq.is/api/pixel/add"
payload = {
    "type": "gtmpixel",
    "name": "My GTM",
    "tag": "GTM-ABCDE"
}
headers = {
    'Authorization': 'Bearer YOURAPIKEY',
    'Content-Type': 'application/json'
}
response = requests.request("POST", url, headers=headers, json=payload)
print(response.text)

var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Post, "https://s.pq.is/api/pixel/add");
request.Headers.Add("Authorization", "Bearer YOURAPIKEY");
var content = new StringContent("{\"type\":\"gtmpixel\",\"name\":\"My GTM\",\"tag\":\"GTM-ABCDE\"}", System.Text.Encoding.UTF8, "application/json");
request.Content = content;
var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());

Server Response

{
    "error": 0,
    "id": 1
}

PUT https://s.pq.is/api/pixel/:id/update

Update Pixel

To update a pixel, you need to send a valid data in JSON via a PUT request. The data must be sent as the raw body of your request as shown below. The example below shows all the parameters you can send but you are not required to send all (See table for more info).

Parameter Description

name (optional) Custom name for your pixel

tag (required) The tag for the pixel

curl --location --request PUT 'https://s.pq.is/api/pixel/:id/update' \
--header 'Authorization: Bearer YOURAPIKEY' \
--header 'Content-Type: application/json' \
--data-raw '{
    "name": "My GTM",
    "tag": "GTM-ABCDE"
}'

$curl = curl_init();
curl_setopt_array($curl, array(
    CURLOPT_URL => "https://s.pq.is/api/pixel/:id/update",
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_MAXREDIRS => 2,
    CURLOPT_TIMEOUT => 10,
    CURLOPT_FOLLOWLOCATION => true,
    CURLOPT_CUSTOMREQUEST => "PUT",
    CURLOPT_HTTPHEADER => [
        "Authorization: Bearer YOURAPIKEY",
        "Content-Type: application/json",
    ],
    CURLOPT_POSTFIELDS => '{
        "name": "My GTM",
        "tag": "GTM-ABCDE"
    }',
));
$response = curl_exec($curl);
curl_close($curl);
echo $response;

var request = require('request');
var options = {
    'method': 'PUT',
    'url': 'https://s.pq.is/api/pixel/:id/update',
    'headers': {
        'Authorization': 'Bearer YOURAPIKEY',
        'Content-Type': 'application/json'
    },
    body: JSON.stringify({
    "name": "My GTM",
    "tag": "GTM-ABCDE"
}),
};
request(options, function (error, response) {
    if (error) throw new Error(error);
    console.log(response.body);
});

import requests
url = "https://s.pq.is/api/pixel/:id/update"
payload = {
    "name": "My GTM",
    "tag": "GTM-ABCDE"
}
headers = {
    'Authorization': 'Bearer YOURAPIKEY',
    'Content-Type': 'application/json'
}
response = requests.request("PUT", url, headers=headers, json=payload)
print(response.text)

var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Put, "https://s.pq.is/api/pixel/:id/update");
request.Headers.Add("Authorization", "Bearer YOURAPIKEY");
var content = new StringContent("{\"name\":\"My GTM\",\"tag\":\"GTM-ABCDE\"}", System.Text.Encoding.UTF8, "application/json");
request.Content = content;
var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());

Server Response

{
    "error": 0,
    "message": "Pixel has been updated successfully."
}

DELETE https://s.pq.is/api/pixel/:id/delete

Delete Pixel

To delete a pixel, you need to send a DELETE request.

curl --location --request DELETE 'https://s.pq.is/api/pixel/:id/delete' \
--header 'Authorization: Bearer YOURAPIKEY' \
--header 'Content-Type: application/json'

$curl = curl_init();
curl_setopt_array($curl, array(
    CURLOPT_URL => "https://s.pq.is/api/pixel/:id/delete",
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_MAXREDIRS => 2,
    CURLOPT_TIMEOUT => 10,
    CURLOPT_FOLLOWLOCATION => true,
    CURLOPT_CUSTOMREQUEST => "DELETE",
    CURLOPT_HTTPHEADER => [
        "Authorization: Bearer YOURAPIKEY",
        "Content-Type: application/json",
    ],
));
$response = curl_exec($curl);
curl_close($curl);
echo $response;

var request = require('request');
var options = {
    'method': 'DELETE',
    'url': 'https://s.pq.is/api/pixel/:id/delete',
    'headers': {
        'Authorization': 'Bearer YOURAPIKEY',
        'Content-Type': 'application/json'
    },
};
request(options, function (error, response) {
    if (error) throw new Error(error);
    console.log(response.body);
});

import requests
url = "https://s.pq.is/api/pixel/:id/delete"
payload = {}
headers = {
    'Authorization': 'Bearer YOURAPIKEY',
    'Content-Type': 'application/json'
}
response = requests.request("DELETE", url, headers=headers, json=payload)
print(response.text)

var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Delete, "https://s.pq.is/api/pixel/:id/delete");
request.Headers.Add("Authorization", "Bearer YOURAPIKEY");
var content = new StringContent("{}", System.Text.Encoding.UTF8, "application/json");
request.Content = content;
var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());

Server Response

{
    "error": 0,
    "message": "Pixel has been deleted successfully."
}

QR Codes

GET https://s.pq.is/api/qr?limit=2&page=1

List QR codes

To get your QR codes via the API, you can use this endpoint. You can also filter data (See table for more info).

Parameter Description

limit (optional) Per page data result

page (optional) Current page request

curl --location --request GET 'https://s.pq.is/api/qr?limit=2&page=1' \
--header 'Authorization: Bearer YOURAPIKEY' \
--header 'Content-Type: application/json'

$curl = curl_init();
curl_setopt_array($curl, array(
    CURLOPT_URL => "https://s.pq.is/api/qr?limit=2&page=1",
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_MAXREDIRS => 2,
    CURLOPT_TIMEOUT => 10,
    CURLOPT_FOLLOWLOCATION => true,
    CURLOPT_CUSTOMREQUEST => "GET",
    CURLOPT_HTTPHEADER => [
        "Authorization: Bearer YOURAPIKEY",
        "Content-Type: application/json",
    ],
));
$response = curl_exec($curl);
curl_close($curl);
echo $response;

var request = require('request');
var options = {
    'method': 'GET',
    'url': 'https://s.pq.is/api/qr?limit=2&page=1',
    'headers': {
        'Authorization': 'Bearer YOURAPIKEY',
        'Content-Type': 'application/json'
    },
};
request(options, function (error, response) {
    if (error) throw new Error(error);
    console.log(response.body);
});

import requests
url = "https://s.pq.is/api/qr?limit=2&page=1"
payload = {}
headers = {
    'Authorization': 'Bearer YOURAPIKEY',
    'Content-Type': 'application/json'
}
response = requests.request("GET", url, headers=headers, json=payload)
print(response.text)

var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Get, "https://s.pq.is/api/qr?limit=2&page=1");
request.Headers.Add("Authorization", "Bearer YOURAPIKEY");
var content = new StringContent("{}", System.Text.Encoding.UTF8, "application/json");
request.Content = content;
var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());

Server Response

{
    "error": "0",
    "data": {
        "result": 2,
        "perpage": 2,
        "currentpage": 1,
        "nextpage": 1,
        "maxpage": 1,
        "qrs": [
            {
                "id": 2,
                "link": "https:\/\/s.pq.is\/qr\/a2d5e",
                "scans": 0,
                "name": "Google",
                "date": "2020-11-10 18:01:43"
            },
            {
                "id": 1,
                "link": "https:\/\/s.pq.is\/qr\/b9edfe",
                "scans": 5,
                "name": "Google Canada",
                "date": "2020-11-10 18:00:25"
            }
        ]
    }
}

GET https://s.pq.is/api/qr/:id

Get a single QR Code

To get details for a single QR code via the API, you can use this endpoint.

curl --location --request GET 'https://s.pq.is/api/qr/:id' \
--header 'Authorization: Bearer YOURAPIKEY' \
--header 'Content-Type: application/json'

$curl = curl_init();
curl_setopt_array($curl, array(
    CURLOPT_URL => "https://s.pq.is/api/qr/:id",
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_MAXREDIRS => 2,
    CURLOPT_TIMEOUT => 10,
    CURLOPT_FOLLOWLOCATION => true,
    CURLOPT_CUSTOMREQUEST => "GET",
    CURLOPT_HTTPHEADER => [
        "Authorization: Bearer YOURAPIKEY",
        "Content-Type: application/json",
    ],
));
$response = curl_exec($curl);
curl_close($curl);
echo $response;

var request = require('request');
var options = {
    'method': 'GET',
    'url': 'https://s.pq.is/api/qr/:id',
    'headers': {
        'Authorization': 'Bearer YOURAPIKEY',
        'Content-Type': 'application/json'
    },
};
request(options, function (error, response) {
    if (error) throw new Error(error);
    console.log(response.body);
});

import requests
url = "https://s.pq.is/api/qr/:id"
payload = {}
headers = {
    'Authorization': 'Bearer YOURAPIKEY',
    'Content-Type': 'application/json'
}
response = requests.request("GET", url, headers=headers, json=payload)
print(response.text)

var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Get, "https://s.pq.is/api/qr/:id");
request.Headers.Add("Authorization", "Bearer YOURAPIKEY");
var content = new StringContent("{}", System.Text.Encoding.UTF8, "application/json");
request.Content = content;
var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());

Server Response

{
    "error": 0,
    "details": {
        "id": 1,
        "link": "https:\/\/s.pq.is\/qr\/b9edfe",
        "scans": 5,
        "name": "Google Canada",
        "date": "2020-11-10 18:00:25"
    },
    "data": {
        "clicks": 1,
        "uniqueClicks": 1,
        "topCountries": {
            "Unknown": "1"
        },
        "topReferrers": {
            "Direct, email and other": "1"
        },
        "topBrowsers": {
            "Chrome": "1"
        },
        "topOs": {
            "Windows 10": "1"
        },
        "socialCount": {
            "facebook": 0,
            "twitter": 0,
            "instagram": 0
        }
    }
}

POST https://s.pq.is/api/qr/add

Create a QR Code

To create a QR Code, you need to send a valid data in JSON via a POST request. The data must be sent as the raw body of your request as shown below. The example below shows all the parameters you can send but you are not required to send all (See table for more info).

Parameter Description

data (required) Data to be embedded inside the QR code. The data can be string or array depending on the type

background (optional) RGB color e.g. rgb(255,255,255)

foreground (optional) RGB color e.g. rgb(0,0,0)

logo (optional) Path to the logo either png or jpg

curl --location --request POST 'https://s.pq.is/api/qr/add' \
--header 'Authorization: Bearer YOURAPIKEY' \
--header 'Content-Type: application/json' \
--data-raw '{
    "type": "link",
    "data": "https:\/\/google.com",
    "background": "rgb(255,255,255)",
    "foreground": "rgb(0,0,0)",
    "logo": "https:\/\/site.com\/logo.png"
}'

$curl = curl_init();
curl_setopt_array($curl, array(
    CURLOPT_URL => "https://s.pq.is/api/qr/add",
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_MAXREDIRS => 2,
    CURLOPT_TIMEOUT => 10,
    CURLOPT_FOLLOWLOCATION => true,
    CURLOPT_CUSTOMREQUEST => "POST",
    CURLOPT_HTTPHEADER => [
        "Authorization: Bearer YOURAPIKEY",
        "Content-Type: application/json",
    ],
    CURLOPT_POSTFIELDS => '{
        "type": "link",
        "data": "https:\/\/google.com",
        "background": "rgb(255,255,255)",
        "foreground": "rgb(0,0,0)",
        "logo": "https:\/\/site.com\/logo.png"
    }',
));
$response = curl_exec($curl);
curl_close($curl);
echo $response;

var request = require('request');
var options = {
    'method': 'POST',
    'url': 'https://s.pq.is/api/qr/add',
    'headers': {
        'Authorization': 'Bearer YOURAPIKEY',
        'Content-Type': 'application/json'
    },
    body: JSON.stringify({
    "type": "link",
    "data": "https:\/\/google.com",
    "background": "rgb(255,255,255)",
    "foreground": "rgb(0,0,0)",
    "logo": "https:\/\/site.com\/logo.png"
}),
};
request(options, function (error, response) {
    if (error) throw new Error(error);
    console.log(response.body);
});

import requests
url = "https://s.pq.is/api/qr/add"
payload = {
    "type": "link",
    "data": "https://google.com",
    "background": "rgb(255,255,255)",
    "foreground": "rgb(0,0,0)",
    "logo": "https://site.com/logo.png"
}
headers = {
    'Authorization': 'Bearer YOURAPIKEY',
    'Content-Type': 'application/json'
}
response = requests.request("POST", url, headers=headers, json=payload)
print(response.text)

var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Post, "https://s.pq.is/api/qr/add");
request.Headers.Add("Authorization", "Bearer YOURAPIKEY");
var content = new StringContent("{\"type\":\"link\",\"data\":\"https:\\/\\/google.com\",\"background\":\"rgb(255,255,255)\",\"foreground\":\"rgb(0,0,0)\",\"logo\":\"https:\\/\\/site.com\\/logo.png\"}", System.Text.Encoding.UTF8, "application/json");
request.Content = content;
var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());

Server Response

{
    "error": 0,
    "id": 3,
    "link": "https:\/\/s.pq.is\/qr\/a58f79"
}

PUT https://s.pq.is/api/qr/:id/update

Update QR Code

To update a QR Code, you need to send a valid data in JSON via a PUT request. The data must be sent as the raw body of your request as shown below. The example below shows all the parameters you can send but you are not required to send all (See table for more info).

Parameter Description

data (required) Data to be embedded inside the QR code. The data can be string or array depending on the type

background (optional) RGB color e.g. rgb(255,255,255)

foreground (optional) RGB color e.g. rgb(0,0,0)

logo (optional) Path to the logo either png or jpg

curl --location --request PUT 'https://s.pq.is/api/qr/:id/update' \
--header 'Authorization: Bearer YOURAPIKEY' \
--header 'Content-Type: application/json' \
--data-raw '{
    "type": "link",
    "data": "https:\/\/google.com",
    "background": "rgb(255,255,255)",
    "foreground": "rgb(0,0,0)",
    "logo": "https:\/\/site.com\/logo.png"
}'

$curl = curl_init();
curl_setopt_array($curl, array(
    CURLOPT_URL => "https://s.pq.is/api/qr/:id/update",
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_MAXREDIRS => 2,
    CURLOPT_TIMEOUT => 10,
    CURLOPT_FOLLOWLOCATION => true,
    CURLOPT_CUSTOMREQUEST => "PUT",
    CURLOPT_HTTPHEADER => [
        "Authorization: Bearer YOURAPIKEY",
        "Content-Type: application/json",
    ],
    CURLOPT_POSTFIELDS => '{
        "type": "link",
        "data": "https:\/\/google.com",
        "background": "rgb(255,255,255)",
        "foreground": "rgb(0,0,0)",
        "logo": "https:\/\/site.com\/logo.png"
    }',
));
$response = curl_exec($curl);
curl_close($curl);
echo $response;

var request = require('request');
var options = {
    'method': 'PUT',
    'url': 'https://s.pq.is/api/qr/:id/update',
    'headers': {
        'Authorization': 'Bearer YOURAPIKEY',
        'Content-Type': 'application/json'
    },
    body: JSON.stringify({
    "type": "link",
    "data": "https:\/\/google.com",
    "background": "rgb(255,255,255)",
    "foreground": "rgb(0,0,0)",
    "logo": "https:\/\/site.com\/logo.png"
}),
};
request(options, function (error, response) {
    if (error) throw new Error(error);
    console.log(response.body);
});

import requests
url = "https://s.pq.is/api/qr/:id/update"
payload = {
    "type": "link",
    "data": "https://google.com",
    "background": "rgb(255,255,255)",
    "foreground": "rgb(0,0,0)",
    "logo": "https://site.com/logo.png"
}
headers = {
    'Authorization': 'Bearer YOURAPIKEY',
    'Content-Type': 'application/json'
}
response = requests.request("PUT", url, headers=headers, json=payload)
print(response.text)

var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Put, "https://s.pq.is/api/qr/:id/update");
request.Headers.Add("Authorization", "Bearer YOURAPIKEY");
var content = new StringContent("{\"type\":\"link\",\"data\":\"https:\\/\\/google.com\",\"background\":\"rgb(255,255,255)\",\"foreground\":\"rgb(0,0,0)\",\"logo\":\"https:\\/\\/site.com\\/logo.png\"}", System.Text.Encoding.UTF8, "application/json");
request.Content = content;
var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());

Server Response

{
    "error": 0,
    "message": "QR has been updated successfully."
}

DELETE https://s.pq.is/api/qr/:id/delete

Delete a QR Code

To delete a QR code, you need to send a DELETE request.

curl --location --request DELETE 'https://s.pq.is/api/qr/:id/delete' \
--header 'Authorization: Bearer YOURAPIKEY' \
--header 'Content-Type: application/json'

$curl = curl_init();
curl_setopt_array($curl, array(
    CURLOPT_URL => "https://s.pq.is/api/qr/:id/delete",
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_MAXREDIRS => 2,
    CURLOPT_TIMEOUT => 10,
    CURLOPT_FOLLOWLOCATION => true,
    CURLOPT_CUSTOMREQUEST => "DELETE",
    CURLOPT_HTTPHEADER => [
        "Authorization: Bearer YOURAPIKEY",
        "Content-Type: application/json",
    ],
));
$response = curl_exec($curl);
curl_close($curl);
echo $response;

var request = require('request');
var options = {
    'method': 'DELETE',
    'url': 'https://s.pq.is/api/qr/:id/delete',
    'headers': {
        'Authorization': 'Bearer YOURAPIKEY',
        'Content-Type': 'application/json'
    },
};
request(options, function (error, response) {
    if (error) throw new Error(error);
    console.log(response.body);
});

import requests
url = "https://s.pq.is/api/qr/:id/delete"
payload = {}
headers = {
    'Authorization': 'Bearer YOURAPIKEY',
    'Content-Type': 'application/json'
}
response = requests.request("DELETE", url, headers=headers, json=payload)
print(response.text)

var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Delete, "https://s.pq.is/api/qr/:id/delete");
request.Headers.Add("Authorization", "Bearer YOURAPIKEY");
var content = new StringContent("{}", System.Text.Encoding.UTF8, "application/json");
request.Content = content;
var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());

Server Response

{
    "error": 0,
    "message": "QR Code has been deleted successfully."
}

Plans

Admin

This endpoint is only accessible by users with admin privileges.

GET https://s.pq.is/api/plans

List Plans

Get a list of all plans on the platform.

curl --location --request GET 'https://s.pq.is/api/plans' \
--header 'Authorization: Bearer YOURAPIKEY' \
--header 'Content-Type: application/json'

$curl = curl_init();
curl_setopt_array($curl, array(
    CURLOPT_URL => "https://s.pq.is/api/plans",
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_MAXREDIRS => 2,
    CURLOPT_TIMEOUT => 10,
    CURLOPT_FOLLOWLOCATION => true,
    CURLOPT_CUSTOMREQUEST => "GET",
    CURLOPT_HTTPHEADER => [
        "Authorization: Bearer YOURAPIKEY",
        "Content-Type: application/json",
    ],
));
$response = curl_exec($curl);
curl_close($curl);
echo $response;

var request = require('request');
var options = {
    'method': 'GET',
    'url': 'https://s.pq.is/api/plans',
    'headers': {
        'Authorization': 'Bearer YOURAPIKEY',
        'Content-Type': 'application/json'
    },
};
request(options, function (error, response) {
    if (error) throw new Error(error);
    console.log(response.body);
});

import requests
url = "https://s.pq.is/api/plans"
payload = {}
headers = {
    'Authorization': 'Bearer YOURAPIKEY',
    'Content-Type': 'application/json'
}
response = requests.request("GET", url, headers=headers, json=payload)
print(response.text)

var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Get, "https://s.pq.is/api/plans");
request.Headers.Add("Authorization", "Bearer YOURAPIKEY");
var content = new StringContent("{}", System.Text.Encoding.UTF8, "application/json");
request.Content = content;
var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());

Server Response

{
    "error": 0,
    "data": [
        {
            "id": 2,
            "name": "Business",
            "free": false,
            "prices": {
                "monthly": 9.99,
                "yearly": 99.99,
                "lifetime": 999.99
            },
            "limits": {
                "links": 100,
                "clicks": 100000,
                "retention": 60,
                "custom": {
                    "enabled": "0"
                },
                "team": {
                    "enabled": "0",
                    "count": "0"
                },
                "splash": {
                    "enabled": "1",
                    "count": "5"
                },
                "overlay": {
                    "enabled": "1",
                    "count": "10"
                },
                "pixels": {
                    "enabled": "1",
                    "count": "10"
                },
                "domain": {
                    "enabled": "1",
                    "count": "1"
                },
                "multiple": {
                    "enabled": "0"
                },
                "alias": {
                    "enabled": "1"
                },
                "device": {
                    "enabled": "0"
                },
                "geo": {
                    "enabled": "0"
                },
                "bundle": {
                    "enabled": "0"
                },
                "parameters": {
                    "enabled": "0"
                },
                "export": {
                    "enabled": "0"
                },
                "api": {
                    "enabled": "0"
                }
            }
        },
        {
            "id": 1,
            "name": "Starter",
            "free": true,
            "prices": null,
            "limits": {
                "links": 10,
                "clicks": 1000,
                "retention": 7,
                "custom": {
                    "enabled": "0"
                },
                "team": {
                    "enabled": "0",
                    "count": "0"
                },
                "splash": {
                    "enabled": "0",
                    "count": "0"
                },
                "overlay": {
                    "enabled": "0",
                    "count": "10"
                },
                "pixels": {
                    "enabled": "0",
                    "count": "10"
                },
                "domain": {
                    "enabled": "0",
                    "count": "0"
                },
                "multiple": {
                    "enabled": "0"
                },
                "alias": {
                    "enabled": "0"
                },
                "device": {
                    "enabled": "0"
                },
                "geo": {
                    "enabled": "0"
                },
                "bundle": {
                    "enabled": "0"
                },
                "parameters": {
                    "enabled": "0"
                },
                "export": {
                    "enabled": "0"
                },
                "api": {
                    "enabled": "0"
                }
            }
        }
    ]
}

PUT https://s.pq.is/api/plan/:planid/user/:userid

To subscribe a user to plan, send a PUT request to this endpoint with the plan id and user id. The type of subscription and the expiration date will need to be specified. If the expiration date is not specified, the date will be adjusted according to the type.

Parameter Description

type monthly | yearly | lifetime

expiration (optional) Expiration date of the plan e.g. 2026-03-14 11:22:43

curl --location --request PUT 'https://s.pq.is/api/plan/:planid/user/:userid' \
--header 'Authorization: Bearer YOURAPIKEY' \
--header 'Content-Type: application/json' \
--data-raw '{
    "type": "monthly",
    "expiration": "2026-03-14 11:22:43"
}'

$curl = curl_init();
curl_setopt_array($curl, array(
    CURLOPT_URL => "https://s.pq.is/api/plan/:planid/user/:userid",
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_MAXREDIRS => 2,
    CURLOPT_TIMEOUT => 10,
    CURLOPT_FOLLOWLOCATION => true,
    CURLOPT_CUSTOMREQUEST => "PUT",
    CURLOPT_HTTPHEADER => [
        "Authorization: Bearer YOURAPIKEY",
        "Content-Type: application/json",
    ],
    CURLOPT_POSTFIELDS => '{
        "type": "monthly",
        "expiration": "2026-03-14 11:22:43"
    }',
));
$response = curl_exec($curl);
curl_close($curl);
echo $response;

var request = require('request');
var options = {
    'method': 'PUT',
    'url': 'https://s.pq.is/api/plan/:planid/user/:userid',
    'headers': {
        'Authorization': 'Bearer YOURAPIKEY',
        'Content-Type': 'application/json'
    },
    body: JSON.stringify({
    "type": "monthly",
    "expiration": "2026-03-14 11:22:43"
}),
};
request(options, function (error, response) {
    if (error) throw new Error(error);
    console.log(response.body);
});

import requests
url = "https://s.pq.is/api/plan/:planid/user/:userid"
payload = {
    "type": "monthly",
    "expiration": "2026-03-14 11:22:43"
}
headers = {
    'Authorization': 'Bearer YOURAPIKEY',
    'Content-Type': 'application/json'
}
response = requests.request("PUT", url, headers=headers, json=payload)
print(response.text)

var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Put, "https://s.pq.is/api/plan/:planid/user/:userid");
request.Headers.Add("Authorization", "Bearer YOURAPIKEY");
var content = new StringContent("{\"type\":\"monthly\",\"expiration\":\"2026-03-14 11:22:43\"}", System.Text.Encoding.UTF8, "application/json");
request.Content = content;
var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());

Server Response

{
    "error": 0,
    "message": "User has been subscribed to this plan."
}

Users

Admin

This endpoint is only accessible by users with admin privileges.

GET https://s.pq.is/api/users?filter=free

List Users

Get a list of all users on the platform. Data can be filtered by sending a filter parameter in the url.

Parameter Description

filter admin | free | pro

email Search a user by email

curl --location --request GET 'https://s.pq.is/api/users?filter=free' \
--header 'Authorization: Bearer YOURAPIKEY' \
--header 'Content-Type: application/json'

$curl = curl_init();
curl_setopt_array($curl, array(
    CURLOPT_URL => "https://s.pq.is/api/users?filter=free",
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_MAXREDIRS => 2,
    CURLOPT_TIMEOUT => 10,
    CURLOPT_FOLLOWLOCATION => true,
    CURLOPT_CUSTOMREQUEST => "GET",
    CURLOPT_HTTPHEADER => [
        "Authorization: Bearer YOURAPIKEY",
        "Content-Type: application/json",
    ],
));
$response = curl_exec($curl);
curl_close($curl);
echo $response;

var request = require('request');
var options = {
    'method': 'GET',
    'url': 'https://s.pq.is/api/users?filter=free',
    'headers': {
        'Authorization': 'Bearer YOURAPIKEY',
        'Content-Type': 'application/json'
    },
};
request(options, function (error, response) {
    if (error) throw new Error(error);
    console.log(response.body);
});

import requests
url = "https://s.pq.is/api/users?filter=free"
payload = {}
headers = {
    'Authorization': 'Bearer YOURAPIKEY',
    'Content-Type': 'application/json'
}
response = requests.request("GET", url, headers=headers, json=payload)
print(response.text)

var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Get, "https://s.pq.is/api/users?filter=free");
request.Headers.Add("Authorization", "Bearer YOURAPIKEY");
var content = new StringContent("{}", System.Text.Encoding.UTF8, "application/json");
request.Content = content;
var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());

Server Response

{
    "error": 0,
    "data": [
        {
            "id": 2,
            "email": "sample2@domain.com",
            "username": "sample2user",
            "avatar": "https:\\\/\\\/domain.com\/content\/avatar2.png",
            "status": "free",
            "planid": 1,
            "expires": null,
            "registered": "2020-11-10 18:01:43",
            "apikey": "ABC123DEF456"
        },
        {
            "id": 1,
            "email": "sample@domain.com",
            "username": "sampleuser",
            "avatar": "https:\\\/\\\/domain.com\/content\/avatar.png",
            "status": "pro",
            "planid": 2,
            "expires": "2022-11-15 15:00:00",
            "registered": "2020-11-10 18:01:43",
            "apikey": "ABC123DEF456"
        }
    ]
}

GET https://s.pq.is/api/user/:id

List a Single User

Get data for a single user.

curl --location --request GET 'https://s.pq.is/api/user/:id' \
--header 'Authorization: Bearer YOURAPIKEY' \
--header 'Content-Type: application/json'

$curl = curl_init();
curl_setopt_array($curl, array(
    CURLOPT_URL => "https://s.pq.is/api/user/:id",
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_MAXREDIRS => 2,
    CURLOPT_TIMEOUT => 10,
    CURLOPT_FOLLOWLOCATION => true,
    CURLOPT_CUSTOMREQUEST => "GET",
    CURLOPT_HTTPHEADER => [
        "Authorization: Bearer YOURAPIKEY",
        "Content-Type: application/json",
    ],
));
$response = curl_exec($curl);
curl_close($curl);
echo $response;

var request = require('request');
var options = {
    'method': 'GET',
    'url': 'https://s.pq.is/api/user/:id',
    'headers': {
        'Authorization': 'Bearer YOURAPIKEY',
        'Content-Type': 'application/json'
    },
};
request(options, function (error, response) {
    if (error) throw new Error(error);
    console.log(response.body);
});

import requests
url = "https://s.pq.is/api/user/:id"
payload = {}
headers = {
    'Authorization': 'Bearer YOURAPIKEY',
    'Content-Type': 'application/json'
}
response = requests.request("GET", url, headers=headers, json=payload)
print(response.text)

var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Get, "https://s.pq.is/api/user/:id");
request.Headers.Add("Authorization", "Bearer YOURAPIKEY");
var content = new StringContent("{}", System.Text.Encoding.UTF8, "application/json");
request.Content = content;
var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());

Server Response

{
    "error": 0,
    "data": {
        "id": 2,
        "email": "sample2@domain.com",
        "username": "sample2user",
        "avatar": "https:\\\/\\\/domain.com\/content\/avatar2.png",
        "status": "free",
        "planid": 1,
        "expires": null,
        "registered": "2020-11-10 18:01:43",
        "apikey": "ABC123DEF456"
    }
}

POST https://s.pq.is/api/user/add

Create User

To create a user, use this endpoint and send the following information as JSON.

Parameter Description

username (required) User's username. Needs to be valid.

email (required) User's email. Needs to be valid.

password (required) User's password. Minimum 5 characters.

planid (optional) Premium plan. This can be found in the admin panel.

expiration (optional) Membership expiration example 2020-12-26 12:00:00

curl --location --request POST 'https://s.pq.is/api/user/add' \
--header 'Authorization: Bearer YOURAPIKEY' \
--header 'Content-Type: application/json' \
--data-raw '{
    "username": "user",
    "password": "1234567891011",
    "email": "demo@yourwebsite.com",
    "planid": 1,
    "expiration": "2020-11-20 11:00:00"
}'

$curl = curl_init();
curl_setopt_array($curl, array(
    CURLOPT_URL => "https://s.pq.is/api/user/add",
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_MAXREDIRS => 2,
    CURLOPT_TIMEOUT => 10,
    CURLOPT_FOLLOWLOCATION => true,
    CURLOPT_CUSTOMREQUEST => "POST",
    CURLOPT_HTTPHEADER => [
        "Authorization: Bearer YOURAPIKEY",
        "Content-Type: application/json",
    ],
    CURLOPT_POSTFIELDS => '{
        "username": "user",
        "password": "1234567891011",
        "email": "demo@yourwebsite.com",
        "planid": 1,
        "expiration": "2020-11-20 11:00:00"
    }',
));
$response = curl_exec($curl);
curl_close($curl);
echo $response;

var request = require('request');
var options = {
    'method': 'POST',
    'url': 'https://s.pq.is/api/user/add',
    'headers': {
        'Authorization': 'Bearer YOURAPIKEY',
        'Content-Type': 'application/json'
    },
    body: JSON.stringify({
    "username": "user",
    "password": "1234567891011",
    "email": "demo@yourwebsite.com",
    "planid": 1,
    "expiration": "2020-11-20 11:00:00"
}),
};
request(options, function (error, response) {
    if (error) throw new Error(error);
    console.log(response.body);
});

import requests
url = "https://s.pq.is/api/user/add"
payload = {
    "username": "user",
    "password": "1234567891011",
    "email": "demo@yourwebsite.com",
    "planid": 1,
    "expiration": "2020-11-20 11:00:00"
}
headers = {
    'Authorization': 'Bearer YOURAPIKEY',
    'Content-Type': 'application/json'
}
response = requests.request("POST", url, headers=headers, json=payload)
print(response.text)

var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Post, "https://s.pq.is/api/user/add");
request.Headers.Add("Authorization", "Bearer YOURAPIKEY");
var content = new StringContent("{\"username\":\"user\",\"password\":\"1234567891011\",\"email\":\"demo@yourwebsite.com\",\"planid\":1,\"expiration\":\"2020-11-20 11:00:00\"}", System.Text.Encoding.UTF8, "application/json");
request.Content = content;
var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());

Server Response

{
    "error": 0,
    "message": "User has been registered.",
    "data": {
        "id": 3,
        "email": "demo@yourwebsite.com",
        "username": "user"
    }
}

DELETE https://s.pq.is/api/user/:id/delete

Delete User

To delete a user, use this endpoint.

curl --location --request DELETE 'https://s.pq.is/api/user/:id/delete' \
--header 'Authorization: Bearer YOURAPIKEY' \
--header 'Content-Type: application/json'

$curl = curl_init();
curl_setopt_array($curl, array(
    CURLOPT_URL => "https://s.pq.is/api/user/:id/delete",
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_MAXREDIRS => 2,
    CURLOPT_TIMEOUT => 10,
    CURLOPT_FOLLOWLOCATION => true,
    CURLOPT_CUSTOMREQUEST => "DELETE",
    CURLOPT_HTTPHEADER => [
        "Authorization: Bearer YOURAPIKEY",
        "Content-Type: application/json",
    ],
));
$response = curl_exec($curl);
curl_close($curl);
echo $response;

var request = require('request');
var options = {
    'method': 'DELETE',
    'url': 'https://s.pq.is/api/user/:id/delete',
    'headers': {
        'Authorization': 'Bearer YOURAPIKEY',
        'Content-Type': 'application/json'
    },
};
request(options, function (error, response) {
    if (error) throw new Error(error);
    console.log(response.body);
});

import requests
url = "https://s.pq.is/api/user/:id/delete"
payload = {}
headers = {
    'Authorization': 'Bearer YOURAPIKEY',
    'Content-Type': 'application/json'
}
response = requests.request("DELETE", url, headers=headers, json=payload)
print(response.text)

var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Delete, "https://s.pq.is/api/user/:id/delete");
request.Headers.Add("Authorization", "Bearer YOURAPIKEY");
var content = new StringContent("{}", System.Text.Encoding.UTF8, "application/json");
request.Content = content;
var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());

Server Response

{
    "error": 0,
    "message": "User has been deleted."
}

GET https://s.pq.is/api/user/login/:id

This endpoint will generate a unique link that will allow the user to automatically login to the platform. SSO login urls are valid for 1 hour and they can be used a single time.

curl --location --request GET 'https://s.pq.is/api/user/login/:id' \
--header 'Authorization: Bearer YOURAPIKEY' \
--header 'Content-Type: application/json'

$curl = curl_init();
curl_setopt_array($curl, array(
    CURLOPT_URL => "https://s.pq.is/api/user/login/:id",
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_MAXREDIRS => 2,
    CURLOPT_TIMEOUT => 10,
    CURLOPT_FOLLOWLOCATION => true,
    CURLOPT_CUSTOMREQUEST => "GET",
    CURLOPT_HTTPHEADER => [
        "Authorization: Bearer YOURAPIKEY",
        "Content-Type: application/json",
    ],
));
$response = curl_exec($curl);
curl_close($curl);
echo $response;

var request = require('request');
var options = {
    'method': 'GET',
    'url': 'https://s.pq.is/api/user/login/:id',
    'headers': {
        'Authorization': 'Bearer YOURAPIKEY',
        'Content-Type': 'application/json'
    },
};
request(options, function (error, response) {
    if (error) throw new Error(error);
    console.log(response.body);
});

import requests
url = "https://s.pq.is/api/user/login/:id"
payload = {}
headers = {
    'Authorization': 'Bearer YOURAPIKEY',
    'Content-Type': 'application/json'
}
response = requests.request("GET", url, headers=headers, json=payload)
print(response.text)

var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Get, "https://s.pq.is/api/user/login/:id");
request.Headers.Add("Authorization", "Bearer YOURAPIKEY");
var content = new StringContent("{}", System.Text.Encoding.UTF8, "application/json");
request.Content = content;
var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());

Server Response

{
    "error": 0,
    "url": "https:\/\/s.pq.is\/user\/login\/sso\/ezzbacrmofzzeqhmsvgcjbxttnfxgxlo"
}

API Documentation

Getting Started

Authentication

Rate Limit

Response Handling

Account

Get Account

Update Account

Branded Domains

List Branded Domains

Create a Branded Domain

Update Domain

Delete Domain

CTA Overlays

List CTA Overlays

Campaigns

List Campaigns

Create a Campaign

Assign a Link to a Campaign

Update Campaign

Delete Campaign

Channels

List Channels

List Channel Items

Create a Channel

Assign an Item to a Channel

Update Channel

Delete Channel

Custom Splash

List Custom Splash

Files

List Files

Upload a file

Links

List Links

Get a Single Link

Shorten a Link

Update Link

Delete a Link

Pixels

List Pixels

Create a Pixel

Update Pixel

Delete Pixel

QR Codes

List QR codes

Get a single QR Code

Create a QR Code

Update QR Code

Delete a QR Code

Plans

List Plans

Subscribe a User to a Plan

Users

List Users

List a Single User

Create User

Delete User

Login User