Signatures

Retrieve all

GET https://brandlinks.org/api/signatures/
curl --request GET \
--url 'https://brandlinks.org/api/signatures/' \
--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. Defaults to 25. 
{
    "data": [
        {
			"id": 1,
			"project_id": 0,
			"name": "Jane Doe",
			"template": "mars",
			"settings": {
				"direction": "ltr",
				"is_removed_branding": true,
				"image_url": "",
				"sign_off": "Regards,",
				"full_name": "Jane Doe",
				"job_title": "CEO",
				"department": "Head of department",
				"company": "Example Company LTD",
				"email": "[email protected]",
				"website_url": "https:\/\/micupharma.com\/",
				"address": "Example Street, nr. 18",
				"address_url": "",
				"phone_number": "",
				"whatsapp": "",
				"facebook_messenger": "",
				"telegram": "",
				"disclaimer": "",
				"font_family": "arial",
				"font_size": 14,
				"width": 500,
				"image_width": 50,
				"socials_width": 20,
				"socials_padding": 10,
				"separator_size": 0,
				"theme_color": "#000000",
				"full_name_color": "#000000",
				"text_color": "#000000",
				"link_color": "#000000",
				"facebook": "micu",
				"twitter": "micu",
				"instagram": "micu",
				"youtube": "micu",
				"tiktok": "",
				"spotify": "",
				"pinterest": "",
				"linkedin": "",
				"snapchat": "",
				"twitch": "",
				"discord": "",
				"github": "",
				"reddit": ""
			},
			"last_datetime": "2023-01-22 15:49:06",
			"datetime": "2023-01-17 20:38:51"
		}
    ],
    "meta": {
        "page": 1,
        "results_per_page": 25,
        "total": 1,
        "total_pages": 1
    },
    "links": {
        "first": "https://brandlinks.org/api/signatures?&page=1",
        "last": "https://brandlinks.org/api/signatures?&page=1",
        "next": null,
        "prev": null,
        "self": "https://brandlinks.org/api/signatures?&page=1"
    }
}

Retrieve one

GET https://brandlinks.org/api/signatures/{signature_id}
curl --request GET \
--url 'https://brandlinks.org/api/signatures/{signature_id}' \
--header 'Authorization: Bearer {api_key}' \ 
{
    "data": {
        "id": 1,
        "project_id": 0,
        "name": "Jane Doe",
        "template": "mars",
        "settings": {
            "direction": "ltr",
            "is_removed_branding": true,
            "image_url": "",
            "sign_off": "Regards,",
            "full_name": "Jane Doe",
            "job_title": "CEO",
            "department": "Head of department",
            "company": "Example Company LTD",
            "email": "[email protected]",
            "website_url": "https:\/\/micupharma.com\/",
            "address": "Example Street, nr. 18",
            "address_url": "",
            "phone_number": "",
            "whatsapp": "",
            "facebook_messenger": "",
            "telegram": "",
            "disclaimer": "",
            "font_family": "arial",
            "font_size": 14,
            "width": 500,
            "image_width": 50,
            "socials_width": 20,
            "socials_padding": 10,
            "separator_size": 0,
            "theme_color": "#000000",
            "full_name_color": "#000000",
            "text_color": "#000000",
            "link_color": "#000000",
            "facebook": "micu",
            "twitter": "micu",
            "instagram": "micu",
            "youtube": "micu",
            "tiktok": "",
            "spotify": "",
            "pinterest": "",
            "linkedin": "",
            "snapchat": "",
            "twitch": "",
            "discord": "",
            "github": "",
            "reddit": ""
        },
        "last_datetime": "2023-01-22 15:49:06",
        "datetime": "2023-01-17 20:38:51"
    }
}

Create

POST https://brandlinks.org/api/signatures
Parameters Details Description
name Required String -
color Optional String -
curl --request POST \
--url 'https://brandlinks.org/api/signatures' \
--header 'Authorization: Bearer {api_key}' \
--header 'Content-Type: multipart/form-data' \
--form 'name=Production' \
--form 'color=#ffffff' \
{
    "data": {
        "id": 1
    }
}

Update

POST https://brandlinks.org/api/signatures/{signature_id}
Parameters Details Description
name Optional String -
color Optional String -
curl --request POST \
--url 'https://brandlinks.org/api/signatures/{signature_id}' \
--header 'Authorization: Bearer {api_key}' \
--header 'Content-Type: multipart/form-data' \
--form 'name=Production' \
--form 'color=#000000' \
{
  "data": {
    "id": 1
  }
}

Delete

DELETE https://brandlinks.org/api/signatures/{signature_id}
curl --request DELETE \
--url 'https://brandlinks.org/api/signatures/{signature_id}' \
--header 'Authorization: Bearer {api_key}' \