Introduction

Base URL: prolinks.pro

This documentation aims to provide all the information you need to work with our API.

<aside>As you scroll, you'll see code examples for working with the API in different programming languages in the dark area to the right (or as part of the content on mobile).
You can switch the language used with the tabs at the top right (or from the nav menu at the top left on mobile).</aside>

Authenticating requests

To authenticate requests, include an Authorization header with the value "Bearer {YOUR_AUTH_KEY}".

All authenticated endpoints are marked with a requires authentication badge in the documentation below.

You can retrieve your token by visiting your dashboard and clicking Generate API token.

Campaign Mediums

Display a listing of the resource.

Example request:

curl --request GET \
    --get "prolinks.pro/api/v1/campaign-mediums" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"organization_id\": 16
}"

const url = new URL(
    "prolinks.pro/api/v1/campaign-mediums"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "organization_id": 16
};

fetch(url, {
    method: "GET",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Store a newly created resource in storage.

Example request:

curl --request POST \
    "prolinks.pro/api/v1/campaign-mediums" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"organization_id\": 16,
    \"name\": \"n\"
}"

const url = new URL(
    "prolinks.pro/api/v1/campaign-mediums"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "organization_id": 16,
    "name": "n"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Request

POST api/v1/campaign-mediums

Headers

Content-Type

Example: application/json

Accept

Example: application/json

Body Parameters

organization_id integer

Must match an existing stored value. Example: 16

name string

Must not be greater than 255 characters. Example: n

Display the specified resource.

Example request:

curl --request GET \
    --get "prolinks.pro/api/v1/campaign-mediums/16" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"organization_id\": 16
}"

const url = new URL(
    "prolinks.pro/api/v1/campaign-mediums/16"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "organization_id": 16
};

fetch(url, {
    method: "GET",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Request

GET api/v1/campaign-mediums/{id}

Headers

Content-Type

Example: application/json

Accept

Example: application/json

URL Parameters

id integer

The ID of the campaign medium. Example: 16

Body Parameters

organization_id integer

Must match an existing stored value. Example: 16

Update the specified resource in storage.

Example request:

curl --request PATCH \
    "prolinks.pro/api/v1/campaign-mediums/16" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"organization_id\": 16,
    \"name\": \"n\"
}"

const url = new URL(
    "prolinks.pro/api/v1/campaign-mediums/16"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "organization_id": 16,
    "name": "n"
};

fetch(url, {
    method: "PATCH",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Request

PATCH api/v1/campaign-mediums/{id}

Headers

Content-Type

Example: application/json

Accept

Example: application/json

URL Parameters

id integer

The ID of the campaign medium. Example: 16

Body Parameters

organization_id integer

Must match an existing stored value. Example: 16

name string

Must not be greater than 255 characters. Example: n

Remove the specified resource from storage.

Example request:

curl --request DELETE \
    "prolinks.pro/api/v1/campaign-mediums/16" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"organization_id\": 16
}"

const url = new URL(
    "prolinks.pro/api/v1/campaign-mediums/16"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "organization_id": 16
};

fetch(url, {
    method: "DELETE",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Request

DELETE api/v1/campaign-mediums/{id}

Headers

Content-Type

Example: application/json

Accept

Example: application/json

URL Parameters

id integer

The ID of the campaign medium. Example: 16

Body Parameters

organization_id integer

Must match an existing stored value. Example: 16

Campaign Sources

Display a listing of the resource.

Example request:

curl --request GET \
    --get "prolinks.pro/api/v1/campaign-sources" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"organization_id\": 16
}"

const url = new URL(
    "prolinks.pro/api/v1/campaign-sources"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "organization_id": 16
};

fetch(url, {
    method: "GET",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Store a newly created resource in storage.

Example request:

curl --request POST \
    "prolinks.pro/api/v1/campaign-sources" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"organization_id\": 16,
    \"name\": \"n\"
}"

const url = new URL(
    "prolinks.pro/api/v1/campaign-sources"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "organization_id": 16,
    "name": "n"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Request

POST api/v1/campaign-sources

Headers

Content-Type

Example: application/json

Accept

Example: application/json

Body Parameters

organization_id integer

Must match an existing stored value. Example: 16

name string

Must not be greater than 255 characters. Example: n

Display the specified resource.

Example request:

curl --request GET \
    --get "prolinks.pro/api/v1/campaign-sources/16" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"organization_id\": 16
}"

const url = new URL(
    "prolinks.pro/api/v1/campaign-sources/16"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "organization_id": 16
};

fetch(url, {
    method: "GET",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Request

GET api/v1/campaign-sources/{id}

Headers

Content-Type

Example: application/json

Accept

Example: application/json

URL Parameters

id integer

The ID of the campaign source. Example: 16

Body Parameters

organization_id integer

Must match an existing stored value. Example: 16

Update the specified resource in storage.

Example request:

curl --request PATCH \
    "prolinks.pro/api/v1/campaign-sources/16" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"organization_id\": 16,
    \"name\": \"n\"
}"

const url = new URL(
    "prolinks.pro/api/v1/campaign-sources/16"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "organization_id": 16,
    "name": "n"
};

fetch(url, {
    method: "PATCH",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Request

PATCH api/v1/campaign-sources/{id}

Headers

Content-Type

Example: application/json

Accept

Example: application/json

URL Parameters

id integer

The ID of the campaign source. Example: 16

Body Parameters

organization_id integer

Must match an existing stored value. Example: 16

name string

Must not be greater than 255 characters. Example: n

Remove the specified resource from storage.

Example request:

curl --request DELETE \
    "prolinks.pro/api/v1/campaign-sources/16" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"organization_id\": 16
}"

const url = new URL(
    "prolinks.pro/api/v1/campaign-sources/16"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "organization_id": 16
};

fetch(url, {
    method: "DELETE",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Request

DELETE api/v1/campaign-sources/{id}

Headers

Content-Type

Example: application/json

Accept

Example: application/json

URL Parameters

id integer

The ID of the campaign source. Example: 16

Body Parameters

organization_id integer

Must match an existing stored value. Example: 16

Domains

GET api/v1/domains

Example request:

curl --request GET \
    --get "prolinks.pro/api/v1/domains" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"organization_id\": 16
}"

const url = new URL(
    "prolinks.pro/api/v1/domains"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "organization_id": 16
};

fetch(url, {
    method: "GET",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

POST api/v1/domains

Example request:

curl --request POST \
    "prolinks.pro/api/v1/domains" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"organization_id\": 16,
    \"name\": \"n\",
    \"redirect_url\": \"http:\\/\\/crooks.biz\\/et-fugiat-sunt-nihil-accusantium\"
}"

const url = new URL(
    "prolinks.pro/api/v1/domains"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "organization_id": 16,
    "name": "n",
    "redirect_url": "http:\/\/crooks.biz\/et-fugiat-sunt-nihil-accusantium"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Request

POST api/v1/domains

Headers

Content-Type

Example: application/json

Accept

Example: application/json

Body Parameters

organization_id integer

Must match an existing stored value. Example: 16

name string

Must not be greater than 255 characters. Example: n

redirect_url string optional

Must be a valid URL. Must not be greater than 2048 characters. Example: http://crooks.biz/et-fugiat-sunt-nihil-accusantium

GET api/v1/domains/{id}

Example request:

curl --request GET \
    --get "prolinks.pro/api/v1/domains/1" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"organization_id\": 16
}"

const url = new URL(
    "prolinks.pro/api/v1/domains/1"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "organization_id": 16
};

fetch(url, {
    method: "GET",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Request

GET api/v1/domains/{id}

Headers

Content-Type

Example: application/json

Accept

Example: application/json

URL Parameters

id integer

The ID of the domain. Example: 1

Body Parameters

organization_id integer

Must match an existing stored value. Example: 16

PATCH api/v1/domains/{id}

Example request:

curl --request PATCH \
    "prolinks.pro/api/v1/domains/1" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"organization_id\": 16,
    \"name\": \"n\",
    \"redirect_url\": \"http:\\/\\/crooks.biz\\/et-fugiat-sunt-nihil-accusantium\"
}"

const url = new URL(
    "prolinks.pro/api/v1/domains/1"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "organization_id": 16,
    "name": "n",
    "redirect_url": "http:\/\/crooks.biz\/et-fugiat-sunt-nihil-accusantium"
};

fetch(url, {
    method: "PATCH",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Request

PATCH api/v1/domains/{id}

Headers

Content-Type

Example: application/json

Accept

Example: application/json

URL Parameters

id integer

The ID of the domain. Example: 1

Body Parameters

organization_id integer

Must match an existing stored value. Example: 16

name string

Must not be greater than 255 characters. Example: n

redirect_url string optional

Must be a valid URL. Must not be greater than 2048 characters. Example: http://crooks.biz/et-fugiat-sunt-nihil-accusantium

DELETE api/v1/domains/{id}

Example request:

curl --request DELETE \
    "prolinks.pro/api/v1/domains/1" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"organization_id\": 16
}"

const url = new URL(
    "prolinks.pro/api/v1/domains/1"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "organization_id": 16
};

fetch(url, {
    method: "DELETE",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Request

DELETE api/v1/domains/{id}

Headers

Content-Type

Example: application/json

Accept

Example: application/json

URL Parameters

id integer

The ID of the domain. Example: 1

Body Parameters

organization_id integer

Must match an existing stored value. Example: 16

Endpoints

GET api/user

Example request:

curl --request GET \
    --get "prolinks.pro/api/user" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "prolinks.pro/api/user"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};


fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

GET api/v1/user

Example request:

curl --request GET \
    --get "prolinks.pro/api/v1/user" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "prolinks.pro/api/v1/user"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};


fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Links

GET api/v1/links

Example request:

curl --request GET \
    --get "prolinks.pro/api/v1/links" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"organization_id\": 16,
    \"domain_id\": 16
}"

const url = new URL(
    "prolinks.pro/api/v1/links"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "organization_id": 16,
    "domain_id": 16
};

fetch(url, {
    method: "GET",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Request

GET api/v1/links

Headers

Content-Type

Example: application/json

Accept

Example: application/json

Body Parameters

organization_id integer

Must match an existing stored value. Example: 16

domain_id integer

Must match an existing stored value. Example: 16

POST api/v1/links

Example request:

curl --request POST \
    "prolinks.pro/api/v1/links" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"organization_id\": 16,
    \"domain_id\": 16,
    \"url\": \"http:\\/\\/bailey.com\\/\",
    \"slug\": \"architecto\",
    \"description\": \"Eius et animi quos velit et.\",
    \"tags\": [
        16
    ],
    \"campaign_source_id\": 16,
    \"campaign_medium_id\": 16,
    \"campaign_id\": \"architecto\",
    \"campaign_name\": \"architecto\",
    \"campaign_term\": \"architecto\",
    \"campaign_content\": \"architecto\",
    \"schedule\": false,
    \"schedule_at\": \"2052-07-09\",
    \"schedule_url\": \"http:\\/\\/bailey.com\\/\",
    \"expires\": false,
    \"expires_at\": \"2052-07-09\",
    \"expires_url\": \"http:\\/\\/bailey.com\\/\",
    \"protect\": true,
    \"ios\": true,
    \"ios_url\": \"http:\\/\\/rempel.com\\/sunt-nihil-accusantium-harum-mollitia\",
    \"android\": true,
    \"android_url\": \"http:\\/\\/www.considine.com\\/provident-perspiciatis-quo-omnis-nostrum-aut-adipisci-quidem\",
    \"windows\": true,
    \"windows_url\": \"http:\\/\\/www.dare.org\\/iure-odit-et-et-modi-ipsum-nostrum-omnis\",
    \"macos\": false,
    \"macos_url\": \"http:\\/\\/mclaughlin.info\\/dolores-enim-non-facere-tempora\",
    \"linux\": true,
    \"linux_url\": \"http:\\/\\/www.leffler.info\\/quis-adipisci-molestias-fugit-deleniti-distinctio-eum\"
}"

const url = new URL(
    "prolinks.pro/api/v1/links"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "organization_id": 16,
    "domain_id": 16,
    "url": "http:\/\/bailey.com\/",
    "slug": "architecto",
    "description": "Eius et animi quos velit et.",
    "tags": [
        16
    ],
    "campaign_source_id": 16,
    "campaign_medium_id": 16,
    "campaign_id": "architecto",
    "campaign_name": "architecto",
    "campaign_term": "architecto",
    "campaign_content": "architecto",
    "schedule": false,
    "schedule_at": "2052-07-09",
    "schedule_url": "http:\/\/bailey.com\/",
    "expires": false,
    "expires_at": "2052-07-09",
    "expires_url": "http:\/\/bailey.com\/",
    "protect": true,
    "ios": true,
    "ios_url": "http:\/\/rempel.com\/sunt-nihil-accusantium-harum-mollitia",
    "android": true,
    "android_url": "http:\/\/www.considine.com\/provident-perspiciatis-quo-omnis-nostrum-aut-adipisci-quidem",
    "windows": true,
    "windows_url": "http:\/\/www.dare.org\/iure-odit-et-et-modi-ipsum-nostrum-omnis",
    "macos": false,
    "macos_url": "http:\/\/mclaughlin.info\/dolores-enim-non-facere-tempora",
    "linux": true,
    "linux_url": "http:\/\/www.leffler.info\/quis-adipisci-molestias-fugit-deleniti-distinctio-eum"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Request

POST api/v1/links

Headers

Content-Type

Example: application/json

Accept

Example: application/json

Body Parameters

organization_id integer

Must match an existing stored value. Example: 16

domain_id integer

Must match an existing stored value. Example: 16

url string

Must be a valid URL. Example: http://bailey.com/

slug string optional

Example: architecto

description string optional

Example: Eius et animi quos velit et.

tags integer[] optional

campaign_source_id integer optional

Example: 16

campaign_medium_id integer optional

Example: 16

campaign_id string optional

Example: architecto

campaign_name string optional

Example: architecto

campaign_term string optional

Example: architecto

campaign_content string optional

Example: architecto

schedule boolean optional true false

Example: false

schedule_at string optional

This field is required when schedule is present. Must be a valid date in the format d/m/Y H:i. Must be a date after now. Example: 2052-07-09

schedule_url string optional

Must be a valid URL. Example: http://bailey.com/

expires boolean optional true false

Example: false

expires_at string optional

This field is required when expires is present. Must be a valid date in the format d/m/Y H:i. Must be a date after now. Example: 2052-07-09

expires_url string optional

Must be a valid URL. Example: http://bailey.com/

protect boolean optional true false

Example: true

ios boolean optional true false

Example: true

ios_url string optional

This field is required when ios is present. Must be a valid URL. Example: http://rempel.com/sunt-nihil-accusantium-harum-mollitia

android boolean optional true false

Example: true

android_url string optional

This field is required when android is present. Must be a valid URL. Example: http://www.considine.com/provident-perspiciatis-quo-omnis-nostrum-aut-adipisci-quidem

windows boolean optional true false

Example: true

windows_url string optional

This field is required when windows is present. Must be a valid URL. Example: http://www.dare.org/iure-odit-et-et-modi-ipsum-nostrum-omnis

macos boolean optional true false

Example: false

macos_url string optional

This field is required when macos is present. Must be a valid URL. Example: http://mclaughlin.info/dolores-enim-non-facere-tempora

linux boolean optional true false

Example: true

linux_url string optional

This field is required when linux is present. Must be a valid URL. Example: http://www.leffler.info/quis-adipisci-molestias-fugit-deleniti-distinctio-eum

GET api/v1/links/{id}

Example request:

curl --request GET \
    --get "prolinks.pro/api/v1/links/16" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"organization_id\": 16,
    \"domain_id\": 16
}"

const url = new URL(
    "prolinks.pro/api/v1/links/16"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "organization_id": 16,
    "domain_id": 16
};

fetch(url, {
    method: "GET",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Request

GET api/v1/links/{id}

Headers

Content-Type

Example: application/json

Accept

Example: application/json

URL Parameters

id integer

The ID of the link. Example: 16

Body Parameters

organization_id integer

Must match an existing stored value. Example: 16

domain_id integer

Must match an existing stored value. Example: 16

GET api/v1/links/{link_id}/qr-code

Example request:

curl --request GET \
    --get "prolinks.pro/api/v1/links/16/qr-code" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "prolinks.pro/api/v1/links/16/qr-code"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};


fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

GET api/v1/links/{link_id}/clicks

Example request:

curl --request GET \
    --get "prolinks.pro/api/v1/links/16/clicks" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"organization_id\": 16
}"

const url = new URL(
    "prolinks.pro/api/v1/links/16/clicks"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "organization_id": 16
};

fetch(url, {
    method: "GET",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Request

GET api/v1/links/{link_id}/clicks

Headers

Content-Type

Example: application/json

Accept

Example: application/json

URL Parameters

link_id integer

The ID of the link. Example: 16

Body Parameters

organization_id integer

Must match an existing stored value. Example: 16

PATCH api/v1/links/{id}

Example request:

curl --request PATCH \
    "prolinks.pro/api/v1/links/16" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"organization_id\": 16,
    \"domain_id\": 16,
    \"url\": \"http:\\/\\/bailey.com\\/\",
    \"slug\": \"architecto\",
    \"description\": \"Eius et animi quos velit et.\",
    \"is_active\": false,
    \"tags\": [
        16
    ],
    \"campaign_source_id\": 16,
    \"campaign_medium_id\": 16,
    \"campaign_id\": \"architecto\",
    \"campaign_name\": \"architecto\",
    \"campaign_term\": \"architecto\",
    \"campaign_content\": \"architecto\",
    \"schedule\": true,
    \"schedule_at\": \"2052-07-09\",
    \"schedule_url\": \"http:\\/\\/bailey.com\\/\",
    \"expires\": true,
    \"expires_at\": \"2052-07-09\",
    \"expires_url\": \"http:\\/\\/bailey.com\\/\",
    \"protect\": true,
    \"ios\": false,
    \"ios_url\": \"http:\\/\\/rempel.com\\/sunt-nihil-accusantium-harum-mollitia\",
    \"android\": false,
    \"android_url\": \"http:\\/\\/www.considine.com\\/provident-perspiciatis-quo-omnis-nostrum-aut-adipisci-quidem\",
    \"windows\": false,
    \"windows_url\": \"http:\\/\\/www.dare.org\\/iure-odit-et-et-modi-ipsum-nostrum-omnis\",
    \"macos\": false,
    \"macos_url\": \"http:\\/\\/mclaughlin.info\\/dolores-enim-non-facere-tempora\",
    \"linux\": true,
    \"linux_url\": \"http:\\/\\/www.leffler.info\\/quis-adipisci-molestias-fugit-deleniti-distinctio-eum\"
}"

const url = new URL(
    "prolinks.pro/api/v1/links/16"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "organization_id": 16,
    "domain_id": 16,
    "url": "http:\/\/bailey.com\/",
    "slug": "architecto",
    "description": "Eius et animi quos velit et.",
    "is_active": false,
    "tags": [
        16
    ],
    "campaign_source_id": 16,
    "campaign_medium_id": 16,
    "campaign_id": "architecto",
    "campaign_name": "architecto",
    "campaign_term": "architecto",
    "campaign_content": "architecto",
    "schedule": true,
    "schedule_at": "2052-07-09",
    "schedule_url": "http:\/\/bailey.com\/",
    "expires": true,
    "expires_at": "2052-07-09",
    "expires_url": "http:\/\/bailey.com\/",
    "protect": true,
    "ios": false,
    "ios_url": "http:\/\/rempel.com\/sunt-nihil-accusantium-harum-mollitia",
    "android": false,
    "android_url": "http:\/\/www.considine.com\/provident-perspiciatis-quo-omnis-nostrum-aut-adipisci-quidem",
    "windows": false,
    "windows_url": "http:\/\/www.dare.org\/iure-odit-et-et-modi-ipsum-nostrum-omnis",
    "macos": false,
    "macos_url": "http:\/\/mclaughlin.info\/dolores-enim-non-facere-tempora",
    "linux": true,
    "linux_url": "http:\/\/www.leffler.info\/quis-adipisci-molestias-fugit-deleniti-distinctio-eum"
};

fetch(url, {
    method: "PATCH",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Request

PATCH api/v1/links/{id}

Headers

Content-Type

Example: application/json

Accept

Example: application/json

URL Parameters

id integer

The ID of the link. Example: 16

Body Parameters

organization_id integer

Must match an existing stored value. Example: 16

domain_id integer

Must match an existing stored value. Example: 16

url string optional

Must be a valid URL. Example: http://bailey.com/

slug string optional

Example: architecto

description string optional

Example: Eius et animi quos velit et.

is_active boolean optional true false

Example: false

tags integer[] optional

campaign_source_id integer optional

Example: 16

campaign_medium_id integer optional

Example: 16

campaign_id string optional

Example: architecto

campaign_name string optional

Example: architecto

campaign_term string optional

Example: architecto

campaign_content string optional

Example: architecto

schedule boolean optional true false

Example: true

schedule_at string optional

This field is required when schedule is true. Must be a valid date in the format d/m/Y H:i. Must be a date after now. Example: 2052-07-09

schedule_url string optional

Must be a valid URL. Example: http://bailey.com/

expires boolean optional true false

Example: true

expires_at string optional

This field is required when expires is true. Must be a valid date in the format d/m/Y H:i. Must be a date after now. Example: 2052-07-09

expires_url string optional

Must be a valid URL. Example: http://bailey.com/

protect boolean optional true false

Example: true

ios boolean optional true false

Example: false

ios_url string optional

This field is required when ios is true. Must be a valid URL. Example: http://rempel.com/sunt-nihil-accusantium-harum-mollitia

android boolean optional true false

Example: false

android_url string optional

This field is required when android is true. Must be a valid URL. Example: http://www.considine.com/provident-perspiciatis-quo-omnis-nostrum-aut-adipisci-quidem

windows boolean optional true false

Example: false

windows_url string optional

This field is required when windows is true. Must be a valid URL. Example: http://www.dare.org/iure-odit-et-et-modi-ipsum-nostrum-omnis

macos boolean optional true false

Example: false

macos_url string optional

This field is required when macos is true. Must be a valid URL. Example: http://mclaughlin.info/dolores-enim-non-facere-tempora

linux boolean optional true false

Example: true

linux_url string optional

This field is required when linux is true. Must be a valid URL. Example: http://www.leffler.info/quis-adipisci-molestias-fugit-deleniti-distinctio-eum

DELETE api/v1/links/{id}

Example request:

curl --request DELETE \
    "prolinks.pro/api/v1/links/16" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"organization_id\": 16,
    \"domain_id\": 16
}"

const url = new URL(
    "prolinks.pro/api/v1/links/16"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "organization_id": 16,
    "domain_id": 16
};

fetch(url, {
    method: "DELETE",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Request

DELETE api/v1/links/{id}

Headers

Content-Type

Example: application/json

Accept

Example: application/json

URL Parameters

id integer

The ID of the link. Example: 16

Body Parameters

organization_id integer

Must match an existing stored value. Example: 16

domain_id integer

Must match an existing stored value. Example: 16

Organizations

GET api/v1/organizations

Example request:

curl --request GET \
    --get "prolinks.pro/api/v1/organizations" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "prolinks.pro/api/v1/organizations"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};


fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

GET api/v1/organizations/{id}

Example request:

curl --request GET \
    --get "prolinks.pro/api/v1/organizations/1" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "prolinks.pro/api/v1/organizations/1"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};


fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Introduction

Authenticating requests

Campaign Mediums

Display a listing of the resource.

Request Try it out ⚡ Cancel 🛑 Send Request 💥

Headers

Body Parameters

Store a newly created resource in storage.

Request Try it out ⚡ Cancel 🛑 Send Request 💥

Headers

Body Parameters

Display the specified resource.

Request Try it out ⚡ Cancel 🛑 Send Request 💥

Headers

URL Parameters

Body Parameters

Update the specified resource in storage.

Request Try it out ⚡ Cancel 🛑 Send Request 💥

Headers

URL Parameters

Body Parameters

Remove the specified resource from storage.

Request Try it out ⚡ Cancel 🛑 Send Request 💥

Headers

URL Parameters

Body Parameters

Campaign Sources

Display a listing of the resource.

Request Try it out ⚡ Cancel 🛑 Send Request 💥

Headers

Body Parameters

Store a newly created resource in storage.

Request Try it out ⚡ Cancel 🛑 Send Request 💥

Headers

Body Parameters

Display the specified resource.

Request Try it out ⚡ Cancel 🛑 Send Request 💥

Headers

URL Parameters

Body Parameters

Update the specified resource in storage.

Request Try it out ⚡ Cancel 🛑 Send Request 💥

Headers

URL Parameters

Body Parameters

Remove the specified resource from storage.

Request Try it out ⚡ Cancel 🛑 Send Request 💥

Headers

URL Parameters

Body Parameters

Domains

GET api/v1/domains

Request Try it out ⚡ Cancel 🛑 Send Request 💥

Headers

Body Parameters

POST api/v1/domains

Request Try it out ⚡ Cancel 🛑 Send Request 💥

Headers

Body Parameters

GET api/v1/domains/{id}

Request Try it out ⚡ Cancel 🛑 Send Request 💥

Headers

URL Parameters

Body Parameters

PATCH api/v1/domains/{id}

Request Try it out ⚡ Cancel 🛑 Send Request 💥

Headers

URL Parameters

Body Parameters

DELETE api/v1/domains/{id}

Request Try it out ⚡ Cancel 🛑 Send Request 💥

Headers

URL Parameters

Body Parameters

Endpoints

GET api/user

Request Try it out ⚡ Cancel 🛑 Send Request 💥

Headers

GET api/v1/user

Request Try it out ⚡ Cancel 🛑 Send Request 💥

Request

Request

Request

Request

Request

Request

Request

Request

Request

Request

Request

Request

Request

Request

Request

Request

Request

Request

Request

Request

Request

Request

Request

Request

Request

Request

Request

Request

Request

Request

Request