API Documentation

This document outlines the API endpoints that adhere to REST architecture principles. Each endpoint will provide a JSON response, accompanied by standard HTTP status codes, and requires Bearer Authentication using an API Key for access.

Authentication

User account

Creating page and links

QR code

Analytics

Workspace

Conversion pixel

Leads

Custom domain

Creating teams

Adding team members

Authentication

API Key: Get this in your account

Base URL

https://app.pushbio.io/api

If you are using a custom domain, replace the root domain (https://app.pushbio.io) with your custom domain.

Authentication

All the API endpoints require an API key sent by the Bearer Authentication method.

Example

 curl --request GET \
--url 'https://newapp.pushbio.io/api/{endpoint}' \
--header 'Authorization: Bearer {api_key}' \

User account

Retrieve user

Endpoint

GET https://newapp.pushbio.io/api/user

Example

 curl --request GET \
--url 'https://newapp.pushbio.io/api/user' \
--header 'Authorization: Bearer {api_key}' \

Response example

{
    "data": {
        "id":"1",
        "type":"users",
        "email":"[email protected]",
        "billing":{
        "type":"personal",
        "name":"John Doe",
        "address":"Lorem Ipsum",
        "city":"Dolor Sit",
        "county":"Amet",
        "zip":"5000",
        "country":"",
        "phone":"",
        "tax_id":""
        "is_enabled":true,
        "plan_id":"custom",
        "plan_expiration_date":"2025-12-12 00:00:00",
        "plan_settings":{
            ...
        },
        "plan_trial_done":false,
        "language":"english",
        "timezone":"UTC",
        "country":null,
        "date":"2020-01-01 00:00:00",
        "last_activity":"2020-01-01 00:00:00",
        "total_logins":10
    }
}

Creating page and links

Retrieve all links

Endpoint

GET https://newapp.pushbio.io/api/links/

Example

 curl --request GET \
--url 'https://newapp.pushbio.io/api/links/' \
--header 'Authorization: Bearer {api_key}' \

Parameters	Details	Description
page	Optional Integer	The page number that you want results from. Defaults to `1`.
results_per_page	Optional Integer	How many results you want per page. Allowed values are: `10` , `25` , `50` , `100` , `250` , `500` , `1000`. Defaults to `25`.

Response example

{
    "data": [
        {
            "id": 1,
            "project_id": null,
            "domain_id": 0,
            "type": "link",
            "url": "example",
            "location_url": "https://example.com/",
            "settings": {
                "password": null,
                "sensitive_content": false
            },
            "clicks": 10,
            "order": 0,
            "start_date": null,
            "end_date": null,
            "date": "2020-11-15 12:00:00"
        }
    ],
    "meta": {
        "page": 1,
        "results_per_page": 25,
        "total": 1,
        "total_pages": 1
    },
    "links": {
        "first": "https://newapp.pushbio.io/api/links?&page=1",
        "last": "https://newapp.pushbio.io/api/links?&page=1",
        "next": null,
        "prev": null,
        "self": "https://newapp.pushbio.io/api/links?&page=1"
    }
}

Retrieve a single link

Endpoint

GET https://newapp.pushbio.io/api/links/{link_id}

Example

curl --request GET \
--url 'https://newapp.pushbio.io/api/links/{link_id}' \
--header 'Authorization: Bearer {api_key}' \

Response example

{
    "data": {
        "id": 1,
        "project_id": null,
        "domain_id": 0,
        "type": "link",
        "url": "example",
        "location_url": "https://example.com/",
        "settings": {
            "password": null,
            "sensitive_content": false
        },
        "clicks": 10,
        "order": 0,
        "start_date": null,
        "end_date": null,
        "date": "2020-11-15 12:00:00"
    }
}

Creating Links

Endpoint

POST https://newapp.pushbio.io/api/links

Parameters	Details	Description
type	Optional String	`link`
location_url	Required String	The URL of the destination.
url	Optional String	The URL alias of the generated link. Leave empty for a randomly generated one.
domain_id	Optional Integer	–
project_id	Optional Integer	–
pixels_ids	Optional Array Integer	–
schedule	Optional Boolean	–
start_date	Optional String	Available when: schedule = true
end_date	Optional String	Available when: schedule = true
clicks_limit	Optional Integer	–
expiration_url	Optional String	–
sensitive_content	Optional Boolean	–
http_status_code	Optional Integer	Allowed values: `301`, `302`, `307`, `308`
app_linking_is_enabled	Optional Boolean	–
cloaking_is_enabled	Optional Boolean	–
cloaking_title	Optional String	–
cloaking_favicon	Optional File	–
password	Optional String	–
targeting_type	Optional String	`country_code` , `device_type` , `browser_language` , `rotation` , `os_name`
targeting_country_code_key[index]	Optional String	(targeting_type=country_code)
targeting_country_code_value[index]	Optional String	(targeting_type=country_code)
targeting_device_type_key[index]	Optional String	(targeting_type=device_type)
targeting_device_type_value[index]	Optional String	(targeting_type=device_type)
targeting_browser_language_key[index]	Optional String	(targeting_type=browser_language)
targeting_browser_language_value[index]	Optional String	(targeting_type=browser_language)
targeting_rotation_key[index]	Optional String	(targeting_type=rotation)
targeting_rotation_value[index]	Optional String	(targeting_type=rotation)
targeting_os_name_key[index]	Optional String	(targeting_type=os_name)
targeting_os_name_value[index]	Optional String	(targeting_type=os_name)

Example

curl --request POST \
--url 'https://newapp.pushbio.io/api/links' \
--header 'Authorization: Bearer {api_key}' \
--header 'Content-Type: multipart/form-data' \
--form 'url=example' \
--form 'location_url=https://newapp.pushbio.io/' \

Response example

{
    "data": {
        "id": 1
    }
}

Updating Links

Endpoint

POST https://newapp.pushbio.io/api/links/{link_id}

Paramater

Parameters	Details	Description
location_url	Optional String	The URL of the destination.
url	Optional String	The URL alias of the generated link. Leave empty for a randomly generated one.
domain_id	Optional Integer	–
project_id	Optional Integer	–
pixels_ids	Optional Array Integer	–
schedule	Optional Boolean	–
start_date	Optional String	Available when: schedule = true
end_date	Optional String	Available when: schedule = true
clicks_limit	Optional Integer	–
expiration_url	Optional String	–
sensitive_content	Optional Boolean	–
http_status_code	Optional Integer	Allowed values: `301`, `302`, `307`, `308`
app_linking_is_enabled	Optional Boolean	–
cloaking_is_enabled	Optional Boolean	–
cloaking_title	Optional String	–
cloaking_favicon	Optional File	–
password	Optional String	–
targeting_type	Optional String	`country_code` , `device_type` , `browser_language` , `rotation` , `os_name`
targeting_country_code_key[index]	Optional String	(targeting_type=country_code)
targeting_country_code_value[index]	Optional String	(targeting_type=country_code)
targeting_device_type_key[index]	Optional String	(targeting_type=device_type)
targeting_device_type_value[index]	Optional String	(targeting_type=device_type)
targeting_browser_language_key[index]	Optional String	(targeting_type=browser_language)
targeting_browser_language_value[index]	Optional String	(targeting_type=browser_language)
targeting_rotation_key[index]	Optional String	(targeting_type=rotation)
targeting_rotation_value[index]	Optional String	(targeting_type=rotation)
targeting_os_name_key[index]	Optional String	(targeting_type=os_name)
targeting_os_name_value[index]	Optional String	(targeting_type=os_name)

Examples

curl --request POST \
--url 'https://newapp.pushbio.io/api/links/{link_id}' \
--header 'Authorization: Bearer {api_key}' \
--header 'Content-Type: multipart/form-data' \
--form 'is_enabled=0' \

Response

{
  "data": {
    "id": 1
  }
}

Deleting Links

Endpoint

DELETE https://newapp.pushbio.io/api/links/{link_id}

Example

curl --request DELETE \
--url 'https://newapp.pushbio.io/api/links/{link_id}' \
--header 'Authorization: Bearer {api_key}' \

QR code

Retrieve all links

Endpoint

GET https://newapp.pushbio.io/api/qr-codes/

Example

curl --request GET \
--url 'https://newapp.pushbio.io/api/qr-codes/' \
--header 'Authorization: Bearer {api_key}' \

Parameters

Parameters	Details	Description
page	Optional Integer	The page number that you want results from. Defaults to `1`.
results_per_page	Optional Integer	How many results you want per page. Allowed values are: `10` , `25` , `50` , `100` , `250` , `500` , `1000`. Defaults to `25`.

Response

{
    "data": [
        {
            "id": 1,
            "type": "url",
            "name": "Example name",
            "qr_code": "https://newapp.pushbio.io/uploads/qr_code/example.svg",
            "qr_code_logo": null,
            "qr_code_background": null,
            "settings": {
                "foreground_type": "color",
                "foreground_color": "#000000",
                "background_color": "#ffffff",
                "custom_eyes_color": false,
                "qr_code_logo_size": 25,
                "size": 500,
                "margin": 0,
                "ecc": "L",
                "url": "https://example.com"
                ...
            },
            "embedded_data": "https://example.com",
            "last_datetime": "2021-10-31 09:47:25",
            "datetime": "2021-10-29 16:32:25"
        },
    ],
    "meta": {
        "page": 1,
        "results_per_page": 25,
        "total": 1,
        "total_pages": 1
    },
    "links": {
        "first": "https://newapp.pushbio.io/api/qr-codes?&page=1",
        "last": "https://newapp.pushbio.io/api/qr-codes?&page=1",
        "next": null,
        "prev": null,
        "self": "https://newapp.pushbio.io/api/qr-codes?&page=1"
    }
}

Retrieve A Single Link

Endpoint

GET https://newapp.pushbio.io/api/qr-codes/{qr_code_id}

Example

curl --request GET \
--url 'https://newapp.pushbio.io/api/qr-codes/{qr_code_id}' \
--header 'Authorization: Bearer {api_key}' \

Response Example

{
    "data": {
        "id": 1,
        "type": "url",
        "name": "Example name",
        "qr_code": "https://newapp.pushbio.io/uploads/qr_code/example.svg",
        "qr_code_logo": null,
        "qr_code_background": null,
        "settings": {
            "foreground_type": "color",
            "foreground_color": "#000000",
            "background_color": "#ffffff",
            "custom_eyes_color": false,
            "qr_code_logo_size": 25,
            "size": 500,
            "margin": 0,
            "ecc": "L",
            "url": "https://example.com"
            ...
        },
        "embedded_data": "https://example.com",
        "last_datetime": "2021-10-31 09:47:25",
        "datetime": "2021-10-29 16:32:25"
    }
}

Creating Links

Endpoint

POST https://newapp.pushbio.io/api/qr-codes

Parameters

Parameters	Details	Description
project_id	Optional Integer	–
name	Required String	–
type	Required String	Allowed values: `text`, `url`, `phone`, `sms`, `email`, `whatsapp`, `facetime`, `location`, `wifi`, `event`, `vcard`, `crypto`, `paypal`, `upi`, `epc`, `pix`
style	Optional String	Allowed values: `square`, `dot`, `round`, `diamond`, `heart`
inner_eye_style	Optional String	Allowed values: `square`, `dot`, `rounded`, `diamond`, `flower`, `leaf`
outer_eye_style	Optional String	Allowed values: `square`, `circle`, `rounded`, `flower`, `leaf`
foreground_type	Optional String	Allowed values: `color`, `gradient`
foreground_color	Optional String	Available when: foreground_type = color
foreground_gradient_style	Optional String	Allowed values: `vertical`, `horizontal`, `diagonal`, `inverse_diagonal`, `radial`
foreground_gradient_one	Optional String	Available when: foreground_type = gradient
foreground_gradient_two	Optional String	Available when: foreground_type = gradient
background_color	Optional String
background_color_transparency	Optional Integer
custom_eyes_color	Optional Boolean
eyes_inner_color	Optional String	Available when: custom_eyes_color = 1
eyes_outer_color	Optional String	Available when: custom_eyes_color = 1
qr_code_logo	Optional File	–
qr_code_logo_size	Optional Integer	5-35
qr_code_background	Optional File	–
qr_code_background_transparency	Optional Integer	0-100
frame	Optional String	Allowed values: `round_bottom_text`, `round_top_text`, `tooltip_bottom_text`, `tooltip_top_text`, `ribbon_bottom_text`, `ribbon_top_text`, `tooltip_snap_top_text`, `tooltip_snap_bottom_text`
frame_text	Optional String
frame_text_size	Optional Integer	-5 – 5
frame_text_font	Optional String	Allowed values: `times_new_roman`, `georgia`, `courier`, `arial`, `helvetica`, `verdana`, `tahoma`, `trebuchet_ms`, `courier_new`, `lucida_console`, `monaco`, `comic_sans_ms`, `impact`
frame_custom_colors	Optional Boolean
frame_color	Optional String	Available when: frame_custom_colors = 1
frame_text_color	Optional String	Available when: frame_custom_colors = 1
size	Optional Integer	50-2000
margin	Optional Integer	0-25
ecc	Optional String	Allowed values: `L`, `M`, `Q`, `H`
text	Optional String	Available when: type = text
url	Optional String	Available when: type = url
phone	Optional String	Available when: type = phone
sms	Optional String	Available when: type = sms
email	Optional String	Available when: type = email
whatsapp	Optional String	Available when: type = whatsapp
facetime	Optional String	Available when: type = facetime
location
wifi
event	Optional String	Available when: type = event
crypto
vcard
paypal
upi
epc
pix

Parameters	Details	Description

Example

curl --request POST \
--url 'https://newapp.pushbio.io/api/qr-codes' \
--header 'Authorization: Bearer {api_key}' \
--header 'Content-Type: multipart/form-data' \
--form 'name=New York' \
--form 'type=text' \
--form 'text=Hello!' \

Response Example

{
    "data": {
        "id": 1
    }
}

Updating Links

Endpoint

POST https://newapp.pushbio.io/api/qr-codes/{qr_code_id}

Parameters

Parameters	Details	Description
project_id	Optional String	–
name	Optional String	–
type	Optional String	Allowed values: `text`, `url`, `phone`, `sms`, `email`, `whatsapp`, `facetime`, `location`, `wifi`, `event`, `vcard`, `crypto`, `paypal`, `upi`, `epc`, `pix`
style	Optional String	Allowed values: `square`, `dot`, `round`, `diamond`, `heart`
inner_eye_style	Optional String	Allowed values: `square`, `dot`, `rounded`, `diamond`, `flower`, `leaf`
outer_eye_style	Optional String	Allowed values: `square`, `circle`, `rounded`, `flower`, `leaf`
foreground_type	Optional String	Allowed values: `color`, `gradient`
foreground_color	Optional String	Available when: foreground_type = color
foreground_gradient_style	Optional String	Allowed values: `vertical`, `horizontal`, `diagonal`, `inverse_diagonal`, `radial`
foreground_gradient_one	Optional String	Available when: foreground_type = gradient
foreground_gradient_two	Optional String	Available when: foreground_type = gradient
background_color	Optional String
background_color_transparency	Optional Integer	0 – 100
custom_eyes_color	Optional Boolean
eyes_inner_color	Optional String	Available when: custom_eyes_color = 1
eyes_outer_color	Optional String	Available when: custom_eyes_color = 1
qr_code_logo	Optional File	–
qr_code_logo_size	Optional Integer	5-35
qr_code_background	Optional File	–
qr_code_background_transparency	Optional Integer	0-100
frame	Optional String	Allowed values: `round_bottom_text`, `round_top_text`, `tooltip_bottom_text`, `tooltip_top_text`, `ribbon_bottom_text`, `ribbon_top_text`, `tooltip_snap_top_text`, `tooltip_snap_bottom_text`
frame_text	Optional String
frame_text_size	Optional Integer	-5 -> 5
frame_text_font	Optional String	Allowed values: `times_new_roman`, `georgia`, `courier`, `arial`, `helvetica`, `verdana`, `tahoma`, `trebuchet_ms`, `courier_new`, `lucida_console`, `monaco`, `comic_sans_ms`, `impact`
frame_custom_colors	Optional Boolean
frame_color	Optional String	Available when: frame_custom_colors = 1
frame_text_color	Optional String	Available when: frame_custom_colors = 1
size	Optional Integer	50-2000
margin	Optional Integer	0-25
ecc	Optional String	Allowed values: `L`, `M`, `Q`, `H`
text	Optional String	Available when: type = text
url	Optional String	Available when: type = url
phone	Optional String	Available when: type = phone
sms	Optional String	Available when: type = sms
email	Optional String	Available when: type = email
whatsapp	Optional String	Available when: type = whatsapp
facetime	Optional String	Available when: type = facetime
location
wifi
event	Optional String	Available when: type = event
crypto
vcard
paypal
upi
epc
pix

Example

curl --request POST \
--url 'https://newapp.pushbio.io/api/qr-codes/{qr_code_id}' \
--header 'Authorization: Bearer {api_key}' \
--header 'Content-Type: multipart/form-data' \
--form 'name=Las Vegas' \

Response Example

{
    "data": {
        "id": 1
    }
}

Delete Links

Endpoint

DELETE https://newapp.pushbio.io/api/qr-codes/{qr_code_id}

Example

curl --request DELETE \
--url 'https://newapp.pushbio.io/api/qr-codes/{qr_code_id}' \
--header 'Authorization: Bearer {api_key}' \

Analytics

Retrieve One Analytics

Endpoint

GET https://newapp.pushbio.io/api/statistics/{link_id}

Parameters

Parameters	Details	Description
start_date	Required	Start date in `Y-m-d` format.
end_date	Required	End date in `Y-m-d` format.
type	Optional	Type of data to be returned. Allowed values are: `overview`, `referrer_host`, `referrer_path`, `country_code`, `city_name`, `os_name`, `browser_name`, `device_type`, `browser_language`, `utm_source`, `utm_medium`, `utm_campaign`. Defaults to `overview`.
country_code	Optional	Parameter only available for the `city_name` type.
utm_source	Optional	Parameter only available for the `utm_medium` and `utm_campaign` type.
utm_medium	Optional	Parameter only available for the `utm_campaign` type.

Example

curl --request GET \
--url 'https://newapp.pushbio.io/api/statistics/{link_id}?start_date=2020-01-01&end_date=2021-01-01' \
--header 'Authorization: Bearer {api_key}' \

Response Example

{
    "data": [
        {
            "pageviews": 20,
            "visitors": 5,
            "formatted_date": "2021-01"
        },
        {
            "pageviews": 35,
            "visitors": 10,
            "formatted_date": "2021-02"
        },
        {
            "pageviews": 50,
            "visitors": 25,
            "formatted_date": "2021-03"
        }
    ]
}

Workspace

Retrieve All Projects

Endpoint

GET https://newapp.pushbio.io/api/projects/

Example

curl --request GET \
--url 'https://newapp.pushbio.io/api/projects/' \
--header 'Authorization: Bearer {api_key}' \

Parameters

Parameters	Details	Description
page	Optional Integer	The page number that you want results from. Defaults to `1`.
results_per_page	Optional Integer	How many results you want per page. Allowed values are: `10` , `25` , `50` , `100` , `250` , `500` , `1000`. Defaults to `25`.

Response Example

{
    "data": [
        {
            "id": 1,
            "name": "Development",
            "color": "#0e23cc",
            "last_datetime": "2021-03-14 21:22:37",
            "datetime": "2021-02-04 17:51:07"
        },
    ],
    "meta": {
        "page": 1,
        "results_per_page": 25,
        "total": 1,
        "total_pages": 1
    },
    "links": {
        "first": "https://newapp.pushbio.io/api/projects?&page=1",
        "last": "https://newapp.pushbio.io/api/projects?&page=1",
        "next": null,
        "prev": null,
        "self": "https://newapp.pushbio.io/api/projects?&page=1"
    }
}

Retrive One Project

Endpoint

GET https://newapp.pushbio.io/api/projects/{project_id}

Example

curl --request GET \
--url 'https://newapp.pushbio.io/api/projects/{project_id}' \
--header 'Authorization: Bearer {api_key}' \

Response Example

{
    "data": {
        "id": 1,
        "name": "Development",
        "color": "#0e23cc",
        "last_datetime": "2021-03-14 21:22:37",
        "datetime": "2021-02-04 17:51:07"
    }
}

Create Project

Endpoint

POST https://newapp.pushbio.io/api/projects

Parameters

Parameters	Details	Description
name	Required String	–
color	Optional String	–

Example

curl --request POST \
--url 'https://newapp.pushbio.io/api/projects' \
--header 'Authorization: Bearer {api_key}' \
--header 'Content-Type: multipart/form-data' \
--form 'name=Production' \
--form 'color=#ffffff' \

Response Example

{
    "data": {
        "id": 1
    }
}

Updating Projects

Endpoint

POST https://newapp.pushbio.io/api/projects/{project_id}

Parameters

Parameters	Details	Description
name	Optional String	–
color	Optional String	–

Example

curl --request POST \
--url 'https://newapp.pushbio.io/api/projects/{project_id}' \
--header 'Authorization: Bearer {api_key}' \
--header 'Content-Type: multipart/form-data' \
--form 'name=Production' \
--form 'color=#000000' \

Response Example

{
  "data": {
    "id": 1
  }
}

Delete Project

Endpoint

DELETE https://newapp.pushbio.io/api/projects/{project_id}

Example

curl --request DELETE \
--url 'https://newapp.pushbio.io/api/projects/{project_id}' \
--header 'Authorization: Bearer {api_key}' \

Conversion pixel

Retrieve all Pixels

Endpoint

GET https://newapp.pushbio.io/api/pixels/

Example

curl --request GET \
--url 'https://newapp.pushbio.io/api/pixels/' \
--header 'Authorization: Bearer {api_key}' \

Parameters

Parameters	Details	Description
page	Optional Integer	The page number that you want results from. Defaults to `1`.
results_per_page	Optional Integer	How many results you want per page. Allowed values are: `10` , `25` , `50` , `100` , `250` , `500` , `1000`. Defaults to `25`.

Response Example

{
    "data": [
        {
            "id": 1,
            "type": "facebook",
            "name": "Fb Ads",
            "pixel": "1234567",
            "last_datetime": "2021-09-28 15:17:52",
            "datetime": "2021-09-28 11:36:38"
        },
    ],
    "meta": {
        "page": 1,
        "results_per_page": 25,
        "total": 1,
        "total_pages": 1
    },
    "links": {
        "first": "https://newapp.pushbio.io/api/pixels?&page=1",
        "last": "https://newapp.pushbio.io/api/pixels?&page=1",
        "next": null,
        "prev": null,
        "self": "https://newapp.pushbio.io/api/pixels?&page=1"
    }
}

Retrieve One Pixels

Endpoint

GET https://newapp.pushbio.io/api/pixels/{pixel_id}

Example

curl --request GET \
--url 'https://newapp.pushbio.io/api/pixels/{pixel_id}' \
--header 'Authorization: Bearer {api_key}' \

Resposne Example

{
    "data": {
        "id": 1,
        "type": "facebook",
        "name": "Fb Ads",
        "pixel": "1234567",
        "last_datetime": "2021-09-28 15:17:52",
        "datetime": "2021-09-28 11:36:38"
    }
}

Create Pixels

Endpoint

POST https://newapp.pushbio.io/api/pixels

Parameters

Parameters	Details	Description
type	Required String	Allowed values: `facebook` , `google_analytics` , `google_tag_manager` , `linkedin` , `pinterest` , `twitter` , `quora` , `tiktok` , `snapchat`
name	Required String	–
pixel	Required String	–

Example

curl --request POST \
--url 'https://newapp.pushbio.io/api/pixels' \
--header 'Authorization: Bearer {api_key}' \
--header 'Content-Type: multipart/form-data' \
--form 'type=facebook' \
--form 'name=Facebook' \
--form 'pixel=12345678' \

Response Example

{
    "data": {
        "id": 1
    }
}

Updating Pixels

Endpoint

POST https://newapp.pushbio.io/api/pixels/{pixel_id}

Parameters

Parameters	Details	Description
type	Optional String	Allowed values: `facebook` , `google_analytics` , `google_tag_manager` , `linkedin` , `pinterest` , `twitter` , `quora` , `tiktok` , `snapchat`
name	Optional String	–
pixel	Optional String	–

Example

curl --request POST \
--url 'https://newapp.pushbio.io/api/pixels/{pixel_id}' \
--header 'Authorization: Bearer {api_key}' \
--header 'Content-Type: multipart/form-data' \
--form 'name=Facebook New Name' \

Example Response

{
  "data": {
    "id": 1
  }
}

Delete Pixels

Endpoint

DELETE https://newapp.pushbio.io/api/pixels/{pixel_id}

Example

curl --request DELETE \
--url 'https://newapp.pushbio.io/api/pixels/{pixel_id}' \
--header 'Authorization: Bearer {api_key}' \

Leads

Custom domain

Retrieve All Domains

Endpoint

GET https://newapp.pushbio.io/api/domains/

Example

curl --request GET \
--url 'https://newapp.pushbio.io/api/domains/' \
--header 'Authorization: Bearer {api_key}' \

Parameters

Parameters	Details	Description
page	Optional Integer	The page number that you want results from. Defaults to `1`.
results_per_page	Optional Integer	How many results you want per page. Allowed values are: `10` , `25` , `50` , `100` , `250` , `500` , `1000`. Defaults to `25`.

Response Example

{
    "data": [
        {
            "id": 1,
            "scheme": "https://",
            "host": "example.com",
            "custom_index_url": "",
            "is_enabled": true,
            "last_datetime": null,
            "datetime": "2021-02-04 23:29:18"
        },
    ],
    "meta": {
        "page": 1,
        "results_per_page": 25,
        "total": 1,
        "total_pages": 1
    },
    "links": {
        "first": "https://newapp.pushbio.io/api/domains?&page=1",
        "last": "https://newapp.pushbio.io/api/domains?&page=1",
        "next": null,
        "prev": null,
        "self": "https://newapp.pushbio.io/api/domains?&page=1"
    }
}

Retrieve One Domain

Endpoint

GET https://newapp.pushbio.io/api/domains/{domain_id}

Example

curl --request GET \
--url 'https://newapp.pushbio.io/api/domains/{domain_id}' \
--header 'Authorization: Bearer {api_key}' \

Response Example

{
    "data": {
        "id": 1,
        "scheme": "https://",
        "host": "example.com",
        "custom_index_url": "",
        "is_enabled": true,
        "last_datetime": null,
        "datetime": "2021-02-04 23:29:18"
    }
}

Create Domain

Endpoint

POST https://newapp.pushbio.io/api/domains

Parameters

Parameters	Details	Description
host	Required String	–
custom_index_url	Optional String	–
custom_not_found_url	Optional String	–

Example

curl --request POST \
--url 'https://newapp.pushbio.io/api/domains' \
--header 'Authorization: Bearer {api_key}' \
--header 'Content-Type: multipart/form-data' \
--form 'host=domain.com' \
--form 'custom_index_url=https://mywebsite.com/' \
--form 'custom_not_found_url=https://mywebsite.com/404-page'

Response Example

{
    "data": {
        "id": 1
    }
}

Update Domain

Endpoint

POST https://newapp.pushbio.io/api/domains/{domain_id}

Parameters

Parameters	Details	Description
host	Optional String	–
custom_index_url	Optional String	–
custom_not_found_url	Optional String	–

Example

curl --request POST \
--url 'https://newapp.pushbio.io/api/domains/{domain_id}' \
--header 'Authorization: Bearer {api_key}' \
--header 'Content-Type: multipart/form-data' \
--form 'host=domain.com' \

Response Example

{
  "data": {
    "id": 1
  }
}

Delete Domains

Endpoint

DELETE https://newapp.pushbio.io/api/domains/{domain_id}

Example

curl --request DELETE \
--url 'https://newapp.pushbio.io/api/domains/{domain_id}' \
--header 'Authorization: Bearer {api_key}' \

Creating teams

Retrieve All

Endpoint

GET https://newapp.pushbio.io/api/teams/

Example

curl --request GET \
--url 'https://newapp.pushbio.io/api/teams/' \
--header 'Authorization: Bearer {api_key}' \

Parameters

Parameters	Details	Description
page	Optional Integer	The page number that you want results from. Defaults to `1`.
results_per_page	Optional Integer	How many results you want per page. Allowed values are: `10` , `25` , `50` , `100` , `250` , `500` , `1000`. Defaults to `25`.

Response Example

{
    "data": [
        {
            "id": 1,
            "name": "Example team",
            "team_members": [
                {
                    "team_member_id": 1,
                    "user_email": "[email protected]",
                    "access": {
                        "read": true,
                        "create": true,
                        "update": true,
                        "delete": false
                    },
                    "status": 1,
                    "datetime": "2022-06-05 14:37:10",
                    "last_datetime": "2022-06-07 13:04:31"
                }
            ],
            "last_datetime": null,
            "datetime": "2022-04-05 21:08:52"
        }
    ],
    "meta": {
        "page": 1,
        "results_per_page": 25,
        "total": 1,
        "total_pages": 1
    },
    "links": {
        "first": "https://newapp.pushbio.io/api/teams?&page=1",
        "last": "https://newapp.pushbio.io/api/teams?&page=1",
        "next": null,
        "prev": null,
        "self": "https://newapp.pushbio.io/api/teams?&page=1"
    }
}

RetrieveOne

Endpoint

GET https://newapp.pushbio.io/api/teams/{team_id}

Example

curl --request GET \
--url 'https://newapp.pushbio.io/api/teams/{team_id}' \
--header 'Authorization: Bearer {api_key}' \

Response Example

{
    "data": {
        "id": 1,
        "name": "Example team",
        "team_members": [
            {
                "team_member_id": 1,
                "user_email": "[email protected]",
                "access": {
                    "read": true,
                    "create": true,
                    "update": true,
                    "delete": false
                },
                "status": 1,
                "datetime": "2022-06-05 14:37:10",
                "last_datetime": "2022-06-07 13:04:31"
            }
        ],
        "last_datetime": null,
        "datetime": "2022-04-05 21:08:52"
    }
}

Create Team

Endpoint

POST https://newapp.pushbio.io/api/teams

Parameters

Parameters	Details	Description
name	Required String

Example

curl --request POST \
--url 'https://newapp.pushbio.io/api/teams' \
--header 'Authorization: Bearer {api_key}' \
--header 'Content-Type: multipart/form-data' \
--form 'name=My team' \

Response Example

{
    "data": {
        "id": 1
    }
}

Update

Endpoint

POST https://newapp.pushbio.io/api/teams/{team_id}

Parameters

Parameters	Details	Description
name	Optional String	–

Example

curl --request POST \
--url 'https://newapp.pushbio.io/api/teams/{team_id}' \
--header 'Authorization: Bearer {api_key}' \
--header 'Content-Type: multipart/form-data' \
--form 'name=My new team name' \

Response Example

{
    "data": {
        "id": 1
    }
}

Delete

Endpoint

DELETE https://newapp.pushbio.io/api/teams/{team_id}

Example

curl --request DELETE \
--url 'https://newapp.pushbio.io/api/teams/{team_id}' \
--header 'Authorization: Bearer {api_key}' \

Adding team members

Retrieve One

Endpoint

GET https://newapp.pushbio.io/api/team-members/{team_id}

Example

curl --request GET \
--url 'https://newapp.pushbio.io/api/team-members/{team_id}' \
--header 'Authorization: Bearer {api_key}' \

Response Example

{
    "data": [
    {
        "id": 1,
        "team_id": 1,
        "user_email": "[email protected]",
        "access": {
            "read": true,
            "create": true,
            "update": true,
            "delete": false
        },
        "status": 1,
        "datetime": "2022-06-05 14:37:10",
        "last_datetime": "2022-06-07 13:04:31"
        }
    ]
}

Create

Endpoint

POST https://newapp.pushbio.io/api/teams

Parameters

Parameters	Details	Description
team_id	Required Integer	–
user_email	Required String	–
access	Optional String Array	`read.all` `create.links` , `create.pixels` , `create.projects` , `create.biolinks_blocks` , `create.qr_codes` , `create.domains` , `create.payment_processors` , `create.signatures` , `create.documents` , `create.images` , `create.transcriptions` , `create.syntheses` , `create.splash_pages` `update.links` , `update.pixels` , `update.projects` , `update.biolinks_blocks` , `update.qr_codes` , `update.domains` , `update.payment_processors` , `update.signatures` , `update.documents` , `update.images` , `update.transcriptions` , `update.syntheses` , `update.splash_pages` `delete.links` , `delete.pixels` , `delete.projects` , `delete.data` , `delete.biolinks_blocks` , `delete.qr_codes` , `delete.domains` , `delete.guests_payments` , `delete.payment_processors` , `delete.signatures` , `delete.documents` , `delete.images` , `delete.transcriptions` , `delete.syntheses` , `delete.splash_pages`

Example

curl --request POST \
--url 'https://newapp.pushbio.io/api/team-members' \
--header 'Authorization: Bearer {api_key}' \
--header 'Content-Type: multipart/form-data' \
--form 'team_id=1' \
--form '[email protected]' \

Response Example

{
    "data": {
        "id": 1
    }
}

Update

Endpoint

POST https://newapp.pushbio.io/api/team-members/{team_member_id}

Parameters

Parameters	Details	Description
access	Optional String Array	`read.all` `create.links` , `create.pixels` , `create.projects` , `create.biolinks_blocks` , `create.qr_codes` , `create.domains` , `create.payment_processors` , `create.signatures` , `create.documents` , `create.images` , `create.transcriptions` , `create.syntheses` , `create.splash_pages` `update.links` , `update.pixels` , `update.projects` , `update.biolinks_blocks` , `update.qr_codes` , `update.domains` , `update.payment_processors` , `update.signatures` , `update.documents` , `update.images` , `update.transcriptions` , `update.syntheses` , `update.splash_pages` `delete.links` , `delete.pixels` , `delete.projects` , `delete.data` , `delete.biolinks_blocks` , `delete.qr_codes` , `delete.domains` , `delete.guests_payments` , `delete.payment_processors` , `delete.signatures` , `delete.documents` , `delete.images` , `delete.transcriptions` , `delete.syntheses` , `delete.splash_pages`

Examples

curl --request POST \
--url 'https://newapp.pushbio.io/api/team-members/{team_member_id}' \
--header 'Authorization: Bearer {api_key}' \
--header 'Content-Type: multipart/form-data' \
--form 'access[]=create' \
--form 'access[]=update' \

Response Example

{
    "data": {
        "id": 1
    }
}

Delete

Endpoint

DELETE https://newapp.pushbio.io/api/team-members/{team_member_id}

Example

curl --request DELETE \
--url 'https://newapp.pushbio.io/api/team-members/{team_member_id}' \
--header 'Authorization: Bearer {api_key}' \