Refresh Token, Base URL, and X-Tenant values.Obtains a new personal access token by exchanging a valid refresh token. Use this endpoint to silently re-authenticate a user without requiring them to re-enter their credentials.
\nUse this endpoint when the current bearer token has expired and a Refresh-Token is available. This avoids prompting the user for their password again.
{\n \"refresh_token\": \"{{Refresh-Token}}\",\n \"email\": \"{{Username}}\"\n}\n\nOn success, returns a 200 OK with a new bearer token:
{\n \"data\": {\n \"token\": \"<JWT>\"\n },\n \"message\": \"Personal access token created successfully\",\n \"success\": true\n}\n\nStore the returned token value in the Bearer-Token environment variable to authenticate subsequent requests.
Authenticates a user using their email and password credentials and returns a JWT access token.
\nMethod: POST
URL: {{Base-URL}}oauth/token
{\n \"email\": \"{{Username}}\",\n \"password\": \"{{Password}}\"\n}\n\n200 OKOn a successful authentication, the API returns a JWT token along with a status message.
\n{\n \"data\": {\n \"token\": \"<JWT token string>\"\n },\n \"message\": \"Personal access token created successfully\",\n \"success\": true\n}\n\nThe returned data.token value should be stored in the Bearer-Token environment variable to authenticate subsequent API requests.
Use any of the OAuth API calls below to generate a Bearer Token. Once generated, save this token in your environment as Bearer-Token to securely authenticate your BL.INK API calls. Your Bearer-Token is valid for 24 hours.
This endpoint retrieves a list of domains.
\nThis is a GET request to the specified URL.
\n","urlObject":{"path":["v5","domains"],"host":["{{Base-URL}}api"],"query":[],"variable":[]}},"response":[{"id":"8242c81f-86d4-471e-b8ec-dbc087ca69bb","name":"List Domain","originalRequest":{"method":"GET","header":[{"key":"X-Tenant","value":"{{X-Tenant}}","type":"text"}],"url":"{{Base-URL}}api/v5/domains"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"awselb/2.0","enabled":true},{"key":"Content-Type","value":"application/json","enabled":true},{"key":"Content-Length","value":"1139","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true},{"key":"Access-Control-Allow-Origin","value":"*","enabled":true},{"key":"Date","value":"Wed, 02 Oct 2024 18:38:21 GMT","enabled":true},{"key":"Cache-Control","value":"no-cache, private","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"uuid\": \"d3967262-7a29-11ee-8542-0a7eff19a1ff\",\n \"name\": \"go.prod-qa.blink.app\",\n \"created_at\": \"2023-11-03T09:17:35+00:00\",\n \"updated_at\": \"2024-10-02T17:49:49+00:00\"\n },\n {\n \"uuid\": \"27675cc0-9469-11ee-8542-0a7eff19a1ff\",\n \"name\": \"links.prod-qa.blink.app\",\n \"created_at\": \"2023-12-06T18:56:24+00:00\",\n \"updated_at\": \"2024-09-27T16:18:53+00:00\"\n },\n {\n \"uuid\": \"a9902fe0-5a5b-11ef-af99-0affc67a3603\",\n \"name\": \"links.prod-qa.blink.app/es\",\n \"created_at\": \"2023-12-06T18:56:24+00:00\",\n \"updated_at\": \"2024-08-14T16:48:36+00:00\"\n },\n {\n \"uuid\": \"fe0ba0b8-6ef6-11ef-af99-0affc67a3603\",\n \"name\": \"batch.blink.app\",\n \"created_at\": \"2024-09-09T22:00:57+00:00\",\n \"updated_at\": \"2024-09-16T15:11:41+00:00\"\n }\n ],\n \"links\": {\n \"first\": \"https://api.blink.app/api/v5/domains?page=1\",\n \"last\": \"https://api.blink.app/api/v5/domains?page=1\",\n \"prev\": null,\n \"next\": null\n },\n \"meta\": {\n \"current_page\": 1,\n \"from\": 1,\n \"last_page\": 1,\n \"links\": [\n {\n \"url\": null,\n \"label\": \"« Previous\",\n \"active\": false\n },\n {\n \"url\": \"https://api.blink.app/api/v5/domains?page=1\",\n \"label\": \"1\",\n \"active\": true\n },\n {\n \"url\": null,\n \"label\": \"Next »\",\n \"active\": false\n }\n ],\n \"path\": \"https://api.blink.app/api/v5/domains\",\n \"per_page\": 100,\n \"to\": 4,\n \"total\": 4\n }\n}"}],"_postman_id":"4a867614-da44-48f9-b09f-efd02f6333c9"},{"name":"Show Domain","event":[{"listen":"test","script":{"id":"8e19908d-9ff1-4b8d-8f6a-279c0ba96c6f","exec":["try {"," pm.test(\"If succesfully retrived the domain\", function () {"," var jsonData = pm.response.json();"," pm.expect(jsonData.message).to.eql('Domain retrieved successfully');"," });"," var uuid_from_response = pm.response.json().data.uuid;"," if (uuid_from_response === pm.environment.get('domain')) {"," console.log('The uuid in the response matches the endpoint\\'s uuid');"," }","} catch(Error){"," console.log('The uuid in the response does not match the endpoint\\'s uuid') ","}","pm.test(\"Response status code is 200\", function () {"," pm.response.to.have.status(200);","});","","","pm.test(\"Response has the required fields\", function () {"," const responseData = pm.response.json();"," "," pm.expect(responseData).to.be.an('object');"," pm.expect(responseData.data).to.be.an('object');"," pm.expect(responseData.data.uuid).to.be.a('string');"," pm.expect(responseData.data.name).to.be.a('string');"," pm.expect(responseData.data.order).to.be.a('number');"," pm.expect(responseData.data.ssl).to.be.a('boolean');"," pm.expect(responseData.data.created_at).to.be.a('string');"," pm.expect(responseData.data.updated_at).to.be.a('string');","});","","","pm.test(\"Uuid is a non-empty string\", function () {"," const responseData = pm.response.json();"," "," pm.expect(responseData.data.uuid).to.be.a('string').and.to.have.lengthOf.at.least(1, \"UUID should not be empty\");","});","","","pm.test(\"Order is a non-negative integer\", function () {"," const responseData = pm.response.json();"," "," pm.expect(responseData).to.be.an('object');"," pm.expect(responseData.data.order).to.exist.and.to.be.a('number').and.to.satisfy((val) => val >= 0, \"Order should be a non-negative integer\");","});","","",""],"type":"text/javascript","packages":{}}}],"id":"91bd6bcc-74e9-4bb1-bdb6-e08cba78c380","protocolProfileBehavior":{"disabledSystemHeaders":{"accept":true},"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"{{Bearer-Token}}"},"isInherited":false},"method":"GET","header":[{"key":"X-Tenant","value":"{{X-Tenant}}","type":"default"},{"key":"Accept","value":"application/json","type":"default"}],"url":"{{Base-URL}}api/v5/domains/{{domain_uuid}}","description":"This endpoint retrieves the details of a specific domain identified by its UUID.
\ndomain_uuid (string, required): The UUID of the domain.Content-Type: application/json
Authorization: Bearer
data (object): An object containing the details of the domain.
uuid (string): The UUID of the domain.
name (string): The name of the domain.
order (integer): The order of the domain.
ssl (boolean): Indicates if SSL is enabled for the domain.
created_at (string): The timestamp when the domain was created.
updated_at (string): The timestamp when the domain was last updated.
message (string): A message related to the response.
success (boolean): Indicates if the request was successful.
This endpoint retrieves a list of domains.
\nThis is a GET request to the specified URL.
\n","urlObject":{"path":["v5","tenants","domains","demo1.loftware.com","status"],"host":["{{Base-URL}}api"],"query":[],"variable":[]}},"response":[],"_postman_id":"e368d09d-9837-4133-a23d-29c364014a49"}],"id":"05b0bff2-e416-4ece-8b9e-605ce5c27039","_postman_id":"05b0bff2-e416-4ece-8b9e-605ce5c27039","description":""},{"name":"Links","item":[{"name":"Create Link","event":[{"listen":"prerequest","script":{"id":"6ad287d3-e849-4259-a53f-53c82ec2553f","exec":["function generateRandomString(length) {"," let result = '';"," const characters = 'ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789';"," const charactersLength = characters.length;"," for (let i = 0; i < length; i++) {"," result += characters.charAt(Math.floor(Math.random() * charactersLength));"," }"," return result;","}","","function generateRandomLink() {"," const baseUrl = 'https://example.com/';"," const linkLength = 50;"," const randomString = generateRandomString(linkLength);"," const randomLink = `${baseUrl}${randomString}`;"," return randomLink;","}","","function getDomainUUid(){"," pm.sendRequest({"," url: pm.environment.get(\"Base-URL\")+'api/v5/domains',"," method: 'GET',",""," header: {"," 'Content-Type': \"application/json\","," 'X-Tenant': pm.environment.get(\"X-Tenant\"),"," 'Accept': 'application/json',"," 'Authorization': 'Bearer '+pm.environment.get(\"Bearer-Token\")"," }"," "," }, function(err, response){"," console.log(response.json())"," })","}","","getDomainUUid();","pm.environment.set(\"randomLink\", generateRandomLink());"],"type":"text/javascript","packages":{},"requests":{}}},{"listen":"test","script":{"id":"2562182d-67b9-40f7-9475-a55e41e731db","exec":["try {"," pm.test(\"Link is created\", function () {"," pm.expect(pm.response.code).to.be.oneOf([201, 202]);"," });"," var jsonData = pm.response.json()"," pm.environment.set('created_link_id',jsonData.data.id)"," pm.test('Link created successfully', function(){"," pm.expect(jsonData.message).to.eql('Link created successfully');"," pm.expect(jsonData.success).to.eql(true)"," });"," pm.test('Long url is created', function(){"," var jsonData = pm.response.json().data.longUrl"," pm.expect(jsonData).to.not.be.null;"," })","} catch (err) {"," console.log('Link not created')"," console.log(err)","}","","pm.test(\"Response status code is 201\", function () {"," pm.expect(pm.response.code).to.equal(201);","});","","","pm.test(\"Response has the required fields\", function () {"," const responseData = pm.response.json();"," "," pm.expect(responseData).to.be.an('object');"," pm.expect(responseData).to.have.property('data');"," "," const data = responseData.data;"," "," pm.expect(data).to.have.property('id');"," pm.expect(data).to.have.property('short_url');"," pm.expect(data).to.have.property('long_url');"," pm.expect(data).to.have.property('clicks');"," pm.expect(data).to.have.property('engagements');"," pm.expect(data).to.have.property('scans');"," pm.expect(data).to.have.property('redirect_type');"," pm.expect(data).to.have.property('created_at');"," pm.expect(data).to.have.property('updated_at');","});",""],"type":"text/javascript","packages":{},"requests":{}}}],"id":"3b2e6a54-0561-4674-90cb-1eb5a0d613f7","protocolProfileBehavior":{"disabledSystemHeaders":{"accept":true},"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"{{Bearer-Token}}"},"isInherited":false},"method":"POST","header":[{"key":"X-Tenant","value":"{{X-Tenant}}","type":"default"},{"key":"Accept","value":"application/json","type":"default"},{"key":"X-Domain","value":"{{domain_uuid}}","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"short_path","value":"example_123","description":"Keyword for Short_URL
\n","type":"text","disabled":true},{"key":"template_uuid","value":"9dc1a52c-dff4-4197-96f5-c93e6521e383","description":"Use a Link Template
\n","type":"text","uuid":"1be9096e-6808-4b4d-bf31-3081bd1e0cdd","disabled":true},{"key":"dupe_check","value":"1","description":"Use Same Keyword if Long_URL exists
\n","type":"text","disabled":true},{"key":"long_url","value":"{{randomLink}}","type":"text","uuid":"287ab9f7-6a48-4ac6-8ef6-6496cea675d2"},{"key":"additional_url_tracking","value":"myvar=123","description":"Additional URL Parameters
\n","type":"text","disabled":true},{"key":"attributes[gtin]","value":"123456","description":"Custom Attributes
\n","type":"text","disabled":true},{"key":"tags[0]","value":"My_Tag","description":"Custom Tags
\n","type":"text","disabled":true},{"key":"redirect_type","value":"301","description":"Redirect Type
\n","type":"text","disabled":true},{"key":"groups[0][uuid]","value":"{{group_uuid}}","description":"Assign Groups to Link
\n","type":"text","disabled":true},{"key":"notes","value":"My Link Notes","description":"Link Notes
\n","type":"text","disabled":true},{"key":"deleted_at","value":"2025-02-13T16:48:39+00:00","description":"Date to Delete Link
\n","type":"text","uuid":"6899593a-af70-40ca-a193-9402059d2037","disabled":true},{"key":"archived_at","value":"2024-02-13T16:48:39+00:00","description":"Date to Archive Link
\n","type":"text","uuid":"9020c320-093f-4fc7-85e0-b49cd607ee25","disabled":true},{"key":"short_path_length","value":"5","description":"Specify your Short Path Length
\n","type":"text","uuid":"da133b35-015b-46a8-9fe0-17bd3767aea8","disabled":true}]},"url":"{{Base-URL}}api/v5/domains/{{domain_uuid}}/links","description":"This API endpoint makes an HTTP POST request to create a new link for a specific domain.
\n","urlObject":{"path":["v5","domains","{{domain_uuid}}","links"],"host":["{{Base-URL}}api"],"query":[],"variable":[]}},"response":[{"id":"a5476796-3449-40de-b517-1806fadf16d3","name":"Create Link","originalRequest":{"method":"POST","header":[{"key":"X-Tenant","value":"{{X-Tenant}}","type":"default"},{"key":"Accept","value":"application/json","type":"default"},{"key":"X-Domain","value":"{{domain_uuid}}","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"long_url","value":"https://example1.com","description":"Destination URL","type":"text"},{"key":"short_path","value":"my_example_keyword_123","description":"Keyword for Short_URL","type":"text"},{"key":"dupe_check","value":"1","description":"Use Same Keyword if Long_URL exists","type":"text"},{"key":"additional_url_tracking","value":"myvar=123","description":"Additional URL Parameters","type":"text"},{"key":"attributes[my-attribute]","value":"attribute_value","description":"Custom Attributes","type":"text","disabled":true},{"key":"tags[my-tag]","value":"tag_value","description":"Custom Tags","type":"text","disabled":true},{"key":"redirect_type","value":"307","description":"Redirect Type","type":"text"},{"key":"notes","value":"My Link Notes","description":"Link Notes","type":"text"},{"key":"groups","value":"{{group_uuid}}","type":"text","disabled":true}],"options":{"raw":{"language":"json"}}},"url":"{{Base-URL}}api/v5/domains/{{domain_uuid}}/links"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"awselb/2.0","enabled":true},{"key":"Content-Type","value":"application/json","enabled":true},{"key":"Content-Length","value":"574","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true},{"key":"Vary","value":"Origin","enabled":true},{"key":"Date","value":"Tue, 14 Jan 2025 15:24:26 GMT","enabled":true},{"key":"Cache-Control","value":"no-cache, private","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"id\": 825391,\n \"additional_url_parameters\": \"myvar=123\",\n \"short_url\": \"https://go.prod-qa.blink.app/my_example_keyword_123\",\n \"long_url\": \"https://example1.com\",\n \"full_url\": \"https://example1.com?myvar=123\",\n \"clicks\": 0,\n \"engagements\": 0,\n \"scans\": 0,\n \"notes\": \"My Link Notes\",\n \"redirect_type\": 307,\n \"created_by\": \"Super Admin\",\n \"owner\": \"Super Admin\",\n \"tags\": [],\n \"attributes\": [],\n \"created_at\": \"2025-01-14T15:23:15+00:00\",\n \"updated_at\": \"2025-01-14T15:24:26+00:00\",\n \"archived_at\": null,\n \"deleted_at\": null,\n \"groups\": [],\n \"link_template\": null\n },\n \"message\": \"Link created successfully\",\n \"success\": true\n}"}],"_postman_id":"3b2e6a54-0561-4674-90cb-1eb5a0d613f7"},{"name":"Update Link","event":[{"listen":"prerequest","script":{"id":"a3b25d2f-c790-4969-95a2-6003afb31baf","exec":["function generateRandomString(length) {"," let result = '';"," const characters = 'ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789';"," const charactersLength = characters.length;"," for (let i = 0; i < length; i++) {"," result += characters.charAt(Math.floor(Math.random() * charactersLength));"," }"," return result;","}","","function generateRandomLink() {"," const baseUrl = 'https://example.com/';"," const linkLength = 50;"," const randomString = generateRandomString(linkLength);"," const randomLink = `${baseUrl}${randomString}`;"," return randomLink;","}","","const randomLink = generateRandomLink();","//pm.request.body.raw = JSON.stringify({long_url: randomLink});"],"type":"text/javascript","packages":{}}},{"listen":"test","script":{"id":"c9f38866-7ebe-40d7-9fd7-5cf00010013e","exec":["try {"," var jsonData = pm.response.json()"," pm.test('Id is the same that was created', function(){"," if (pm.response.json().data.id === pm.environment.get('created_link_id')) {"," console.log('The recently created link ID is identical to the updated one');"," }"," });"," pm.test('Link updated successfully', function(){"," pm.expect(jsonData.message).to.eql('Link updated successfully');"," pm.expect(jsonData.success).to.eql(true)"," });","} catch (err){"," console.log('Link can not be updated')","}","pm.test(\"Response status code is 200\", function () {"," pm.response.to.have.status(200);","});","","","pm.test(\"Content-Type is application/json\", function () {"," pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(\"application/json\");","});","","","pm.test(\"Data object has the required fields\", function () {"," const responseData = pm.response.json().data;",""," pm.expect(responseData).to.be.an('object');"," pm.expect(responseData).to.have.property('id');"," pm.expect(responseData).to.have.property('short_url');"," pm.expect(responseData).to.have.property('long_url');"," pm.expect(responseData).to.have.property('clicks');"," pm.expect(responseData).to.have.property('engagements');"," pm.expect(responseData).to.have.property('scans');"," pm.expect(responseData).to.have.property('redirect_type');","});","","","pm.test(\"Tags array is present and empty\", function () {"," const responseData = pm.response.json();"," "," pm.expect(responseData).to.have.property('data');"," pm.expect(responseData.data.tags).to.be.an('array').that.is.empty;","});","","","pm.test(\"Message is an empty string and success is true\", function () {"," const responseData = pm.response.json();"," "," pm.expect(responseData.message).to.equal(\"\");"," pm.expect(responseData.success).to.be.true;","});"],"type":"text/javascript","packages":{}}}],"id":"40d65d24-5731-49e8-a1b7-fd5648fa0084","protocolProfileBehavior":{"disabledSystemHeaders":{"accept":true},"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"{{Bearer-Token}}"},"isInherited":false},"method":"PATCH","header":[{"key":"Accept","value":"application/json","type":"default"},{"key":"X-Tenant","value":"{{X-Tenant}}","type":"default"}],"body":{"mode":"raw","raw":"{\n \"long_url\": \"https://www.example.com\"\n}","options":{"raw":{"language":"json"}}},"url":"{{Base-URL}}api/v5/domains/{{domain_uuid}}/links/{{created_link_id}}","description":"This endpoint is used to update a specific link within a domain.
\nThe purpose of this request is to modify the properties of an existing link identified by created_link_id within a specified domain identified by domain_uuid.
{\n \"long_url\": \"https://www.example.com\"\n}\n\nThe response will contain a JSON object with the following properties:
\ndata: An object containing details about the updated link:
\nid: (integer) The unique identifier of the link.
\nadditional_url_parameters: (nullable) Any additional parameters associated with the URL, if applicable.
\nshort_url: (string) The shortened URL generated.
\nlong_url: (string) The long URL that was set.
\nfull_url: (string) The complete URL including any parameters.
\nclicks: (integer) The number of clicks recorded for the link.
\nengagements: (integer) The number of engagements for the link.
\nscans: (integer) The number of scans for the link.
\nnotes: (nullable) Any notes associated with the link.
\nredirect_type: (integer) The type of redirect used.
\ncreated_by: (string) The user who created the link.
\nowner: (string) The owner of the link.
\ntags: (array) Any tags associated with the link.
\ncreated_at: (string) The timestamp when the link was created.
\nupdated_at: (string) The timestamp when the link was last updated.
\narchived_at: (nullable) The timestamp when the link was archived, if applicable.
\ndeleted_at: (nullable) The timestamp when the link was deleted, if applicable.
\ngroups: (array) Any groups associated with the link.
\nlink_template: (nullable) The template used for the link, if applicable.
\nmessage: (string) A message indicating the result of the operation.
\nsuccess: (boolean) Indicates whether the request was successful.
\n{\n \"data\": {\n \"id\": 0,\n \"additional_url_parameters\": null,\n \"short_url\": \"\",\n \"long_url\": \"\",\n \"full_url\": \"\",\n \"clicks\": 0,\n \"engagements\": 0,\n \"scans\": 0,\n \"notes\": null,\n \"redirect_type\": 0,\n \"created_by\": \"\",\n \"owner\": \"\",\n \"tags\": [],\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"archived_at\": null,\n \"deleted_at\": null,\n \"groups\": [],\n \"link_template\": null\n },\n \"message\": \"\",\n \"success\": true\n}\n\nUpdated Keyword / Short URL
\n","type":"text/plain"},"key":"keyword","value":"my_example_keyword"},{"disabled":true,"description":{"content":"Updated Redirect Type
\n","type":"text/plain"},"key":"redirect_type","value":"307"},{"disabled":true,"description":{"content":"Updated Notes
\n","type":"text/plain"},"key":"notes","value":"Link Notes"},{"disabled":true,"description":{"content":"Update URL Attributes
\n","type":"text/plain"},"key":"additional_url_tracking","value":"my_var=123"},{"disabled":true,"description":{"content":"Date to Archive Link
\n","type":"text/plain"},"key":"archived_at","value":"2024-10-21T14:57:09"},{"disabled":true,"description":{"content":"Date to Delete Link
\n","type":"text/plain"},"key":"deleted_at","value":"2024-10-21T14:57:09"}],"variable":[]}},"response":[{"id":"a8c69bb1-7e6f-4f93-9170-4ac7cb227543","name":"Update Link","originalRequest":{"method":"PATCH","header":[{"key":"Accept","value":"application/json","type":"default"},{"key":"X-Tenant","value":"{{X-Tenant}}","type":"default"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":{"raw":"{{Base-URL}}api/v5/domains/{{domain_uuid}}/links/{{created_link_id}}?long_url=https://example.com¬es=Link Notes&redirect_type=307","host":["{{Base-URL}}api"],"path":["v5","domains","{{domain_uuid}}","links","{{created_link_id}}"],"query":[{"key":"long_url","value":"https://example.com","description":"Updated Long URL"},{"key":"notes","value":"Link Notes","description":"Updated Notes"},{"key":"redirect_type","value":"307","description":"Updated Redirect Type"},{"key":"owner","value":"owner@company.com","description":"Updated Owner","type":"text","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"awselb/2.0","enabled":true},{"key":"Content-Type","value":"application/json","enabled":true},{"key":"Content-Length","value":"511","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true},{"key":"Access-Control-Allow-Origin","value":"*","enabled":true},{"key":"Date","value":"Wed, 02 Oct 2024 19:40:58 GMT","enabled":true},{"key":"Cache-Control","value":"no-cache, private","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"id\": 798059,\n \"additional_url_parameters\": null,\n \"short_url\": \"https://go.prod-qa.blink.app/interface_feed\",\n \"long_url\": \"https://example.com\",\n \"full_url\": \"https://example.com\",\n \"clicks\": 0,\n \"engagements\": 0,\n \"scans\": 0,\n \"notes\": \"Link Notes\",\n \"redirect_type\": 307,\n \"created_by\": \"Super Admin\",\n \"owner\": \"Super Admin\",\n \"tags\": [],\n \"attributes\": [],\n \"created_at\": \"2024-10-02T19:37:55+00:00\",\n \"updated_at\": \"2024-10-02T19:40:31+00:00\",\n \"archived_at\": null,\n \"deleted_at\": null\n },\n \"message\": \"Link updated successfully\",\n \"success\": true\n}"}],"_postman_id":"40d65d24-5731-49e8-a1b7-fd5648fa0084"},{"name":"List Links","event":[{"listen":"test","script":{"id":"39c02a79-494a-40a7-9552-7b83e5a34fc7","exec":["// Test for the status code","pm.test(\"Status code is 200\", function () {"," pm.response.to.have.status(200);","});","","// Test for the content type","pm.test(\"Content type is application/json\", function () {"," pm.response.to.have.header(\"Content-Type\", \"application/json\");","});","","// Test for the response body properties","pm.test(\"Response body has data, links, and meta properties\", function () {"," const responseBody = pm.response.json();"," pm.expect(responseBody).to.have.property(\"data\");"," pm.expect(responseBody).to.have.property(\"links\");"," pm.expect(responseBody).to.have.property(\"meta\");","});",""],"type":"text/javascript","packages":{}}},{"listen":"prerequest","script":{"id":"c8024494-2352-4a92-8979-176e6317a440","exec":[""],"type":"text/javascript","packages":{}}}],"id":"796964cb-4a69-40fb-8eaf-5008ad62ac22","protocolProfileBehavior":{"disabledSystemHeaders":{"accept":true},"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"{{Bearer-Token}}"},"isInherited":false},"method":"GET","header":[{"key":"X-Tenant","value":"{{X-Tenant}}"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"{{Base-URL}}api/v5/domains/{{domain_uuid}}/links","description":"This endpoint makes an HTTP GET request to retrieve the links associated with a specific domain.
\nThe response will include the details of the links associated with the specified domain.
\n","urlObject":{"path":["v5","domains","{{domain_uuid}}","links"],"host":["{{Base-URL}}api"],"query":[{"disabled":true,"description":{"content":"Filter by \"From\" Date
\n","type":"text/plain"},"key":"from_date","value":"2025-07-28T00:00:00"},{"disabled":true,"description":{"content":"Filter by \"To\" Date
\n","type":"text/plain"},"key":"to_date","value":"2025-07-30T23:00:00"},{"disabled":true,"description":{"content":"Filter by \"Is Any Of\" keyword
\n","type":"text/plain"},"key":"keyword","value":"my_keyword"},{"disabled":true,"description":{"content":"Filter by \"Is\" keyword
\n","type":"text/plain"},"key":"exact_keyword","value":"my_exact_keyword"},{"disabled":true,"description":{"content":"Filter by Destination URL
\n","type":"text/plain"},"key":"destination_url","value":"https://example.com"},{"disabled":true,"description":{"content":"Filter by Group
\n","type":"text/plain"},"key":"group_id","value":"{{group_uuid}}"},{"disabled":true,"description":{"content":"Filter by Attribute Value
\n","type":"text/plain"},"key":"attributes[my-attribute][value]","value":"123"},{"disabled":true,"description":{"content":"Filter by Attribute Condition (and/or)
\n","type":"text/plain"},"key":"attributes[my-attribute][condition]","value":"and"},{"disabled":true,"description":{"content":"Filter by Additional Attribute Condition
\n","type":"text/plain"},"key":"attributes[my-attribute][value]","value":"456"},{"disabled":true,"description":{"content":"Number of links to show in Results JSON
\n","type":"text/plain"},"key":"per_page","value":"100"},{"disabled":true,"description":{"content":"Filter by Link Template
\n","type":"text/plain"},"key":"template_uuid","value":"9dc1a52c-dff4-4197-96f5-c93e6521e383"},{"disabled":true,"key":"owner","value":"10980425-995f-46be-b9e5-335e8617a87c"}],"variable":[]}},"response":[{"id":"37fcf451-3630-421f-b3bb-8371b1aff9ee","name":"List Links","originalRequest":{"method":"GET","header":[{"key":"X-Tenant","value":"{{X-Tenant}}"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":{"raw":"{{Base-URL}}api/v5/domains/{{domain_uuid}}/links","host":["{{Base-URL}}api"],"path":["v5","domains","{{domain_uuid}}","links"],"query":[{"key":"from_date","value":"2024-05-22T20:03:01+00:00","description":"Filter by \"From\" Date","disabled":true},{"key":"to_date","value":"2024-05-23T20:03:01+00:00","description":"Filter by \"To\" Date","disabled":true},{"key":"keyword","value":"","description":"Filter by \"Is Any Of\" keyword","type":"text","disabled":true},{"key":"exact_keyword","value":"pLJM47b","description":"Filter by \"Is\" keyword","disabled":true},{"key":"destination_url","value":"https://example.com","description":"Filter by Destination URL","disabled":true},{"key":"group_id","value":"{{group_uuid}}","description":"Filter by Group","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"awselb/2.0","enabled":true},{"key":"Content-Type","value":"application/json","description":"","type":"text","enabled":true},{"key":"Content-Length","value":"49866","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true},{"key":"Vary","value":"Origin","enabled":true},{"key":"Date","value":"Thu, 27 Feb 2025 15:14:13 GMT","enabled":true},{"key":"Cache-Control","value":"no-cache, private","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"id\": 31247235,\n \"additional_url_parameters\": null,\n \"short_url\": \"https://batch.blink.app/pAloAs\",\n \"long_url\": \"https://example.com\",\n \"full_url\": \"https://example.com\",\n \"clicks\": 0,\n \"engagements\": 0,\n \"scans\": 0,\n \"notes\": null,\n \"attribute_values\": [],\n \"redirect_type\": 301,\n \"type\": \"Link\",\n \"created_by\": \"super-admin@blink.app\",\n \"owner\": \"super-admin@blink.app\",\n \"created_at\": \"2025-01-23T15:54:49+00:00\",\n \"updated_at\": \"2025-01-23T15:54:49+00:00\",\n \"groups\": [],\n \"link_template\": null,\n \"status\": \"ACTIVE\"\n },\n {\n \"id\": 31247236,\n \"additional_url_parameters\": null,\n \"short_url\": \"https://batch.blink.app/dSRIzV\",\n \"long_url\": \"https://example.com\",\n \"full_url\": \"https://example.com\",\n \"clicks\": 0,\n \"engagements\": 0,\n \"scans\": 0,\n \"notes\": null,\n \"attribute_values\": [],\n \"redirect_type\": 301,\n \"type\": \"Link\",\n \"created_by\": \"super-admin@blink.app\",\n \"owner\": \"super-admin@blink.app\",\n \"created_at\": \"2025-01-23T15:54:49+00:00\",\n \"updated_at\": \"2025-01-23T15:54:49+00:00\",\n \"groups\": [],\n \"link_template\": null,\n \"status\": \"ACTIVE\"\n }\n ],\n \"links\": {\n \"first\": \"https://api.blink.app/api/v5/domains/fe0ba0b8-6ef6-11ef-af99-0affc67a3603/links?page=1\",\n \"last\": \"https://api.blink.app/api/v5/domains/fe0ba0b8-6ef6-11ef-af99-0affc67a3603/links?page=3499\",\n \"prev\": null,\n \"next\": \"https://api.blink.app/api/v5/domains/fe0ba0b8-6ef6-11ef-af99-0affc67a3603/links?page=2\"\n },\n \"meta\": {\n \"current_page\": 1,\n \"from\": 1,\n \"last_page\": 3499,\n \"links\": [\n {\n \"url\": null,\n \"label\": \"« Previous\",\n \"active\": false\n },\n {\n \"url\": \"https://api.blink.app/api/v5/domains/fe0ba0b8-6ef6-11ef-af99-0affc67a3603/links?page=1\",\n \"label\": \"1\",\n \"active\": true\n }\n ],\n \"path\": \"https://api.blink.app/api/v5/domains/fe0ba0b8-6ef6-11ef-af99-0affc67a3603/links\",\n \"per_page\": 100,\n \"to\": 100,\n \"total\": 349813\n }\n}"}],"_postman_id":"796964cb-4a69-40fb-8eaf-5008ad62ac22"},{"name":"Show Link","event":[{"listen":"test","script":{"id":"3a12e029-9d77-4c57-a144-f43f4d46e85a","exec":["try {"," if (pm.response.json().data !== null) {"," pm.test(\"Status code is 200\", function () {"," pm.response.to.have.status(200);"," });"," pm.test(\"Link retrieved successfully\", function () {"," var jsonData = pm.response.json();"," pm.expect(jsonData.message).to.eql('Link retrieved successfully');"," });"," }","} catch (error) {"," console.log('Data is null')","}"],"type":"text/javascript","packages":{}}},{"listen":"prerequest","script":{"id":"53e93e6e-5a51-4a08-8c6a-30b171bdaaef","exec":["const linkID = Math.floor(Math.random() * 15) + 1;","pm.environment.set(\"linkID\", linkID);"],"type":"text/javascript","packages":{}}}],"id":"37466b93-619b-4683-b1a0-f3a525803d0f","protocolProfileBehavior":{"disabledSystemHeaders":{"accept":true},"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"{{Bearer-Token}}"},"isInherited":false},"method":"GET","header":[{"key":"X-Tenant","value":"{{X-Tenant}}","type":"default"},{"key":"Accept","value":"application/json","type":"default"}],"url":"{{Base-URL}}api/v5/domains/{{domain_uuid}}/links/{{link_id}}","description":"This endpoint retrieves details for a specific link within a domain.
\nMethod: GET
URL: {{Base-URL}}api/v5/domains/{{domain_uuid}}/links/{{link_id}}
This endpoint is used to delete a specific link within a domain.
\nMethod: DELETE
URL: {{Base-URL}}api/v5/domains/{{domain_uuid}}/links/{{link_id}}
This endpoint allows you to validate a given URL.
\n","urlObject":{"path":["v5","links","validate"],"host":["{{Base-URL}}api"],"query":[{"description":{"content":"The Full URL to be validated
\n","type":"text/plain"},"key":"url","value":"https://example.com"}],"variable":[]}},"response":[{"id":"ee809f79-29a7-480f-81c7-d45fbfb867af","name":"Validate Link URL","originalRequest":{"method":"POST","header":[{"key":"X-Tenant","value":"{{X-Tenant}}"}],"url":{"raw":"{{Base-URL}}api/v5/links/validate?url=https://example.com","host":["{{Base-URL}}api"],"path":["v5","links","validate"],"query":[{"key":"url","value":"https://example.com","description":"The Full URL to be validated"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"awselb/2.0","enabled":true},{"key":"Content-Type","value":"application/json","enabled":true},{"key":"Content-Length","value":"85","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true},{"key":"Access-Control-Allow-Origin","value":"*","enabled":true},{"key":"Date","value":"Wed, 02 Oct 2024 19:42:43 GMT","enabled":true},{"key":"Cache-Control","value":"no-cache, private","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"url\": \"https://example.com\"\n },\n \"message\": \"The URL is valid.\",\n \"success\": true\n}"}],"_postman_id":"e1ea7560-2b0b-4372-afb4-53efc2820c65"}],"id":"14df5604-d904-4e5e-a4f6-1cfcff84cac1","_postman_id":"14df5604-d904-4e5e-a4f6-1cfcff84cac1","description":""},{"name":"GS1 Links","item":[{"name":"Create GS1 Link","event":[{"listen":"test","script":{"id":"85d77a43-fddd-4816-9d3f-bc24b2991a55","exec":["// Test for status code","pm.test(\"Status code is 201\", function () {"," pm.response.to.have.status(201);","});","","// Test for response body schema","pm.test(\"Response body has the correct schema\", function () {"," const response = pm.response.json();"," pm.expect(response.data).to.have.property('id');"," pm.expect(response.data).to.have.property('domain');"," pm.expect(response.data).to.have.property('path');"," pm.expect(response.data).to.have.property('short_url');"," pm.expect(response.data).to.have.property('long_url');"," pm.expect(response.data).to.have.property('full_url');"," pm.expect(response.data).to.have.property('notes');"," pm.expect(response.data).to.have.property('redirect_type');"," pm.expect(response.data).to.have.property('created_at');"," pm.expect(response.data).to.have.property('updated_at');"," pm.expect(response.data).to.have.property('assigned_attributes');","});","","// Test for response time","pm.test(\"Response time is less than 3000ms\", function () {"," pm.expect(pm.response.responseTime).to.be.below(3000);","});",""],"type":"text/javascript","packages":{},"requests":{}}}],"id":"b5ad9fda-9b58-4189-bb3f-b6ab869ef977","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"{{Bearer-Token}}"},"isInherited":false},"method":"POST","header":[{"key":"X-Domain","value":"{{domain_uuid}}","type":"text"},{"key":"X-Tenant","value":"{{X-Tenant}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"long_url\": \"https://www.example.com\",\r\n \"assigned_attributes\": [\r\n {\r\n \"uuid\": \"9f88039e-5f20-4625-868a-19fbe7861113\",\r\n \"value\": \"12345678901229\"\r\n }\r\n ],\r\n \"groups\": [\r\n {\r\n \"uuid\": \"a0d808d7-9514-4762-bfd5-b6bda0433880\",\r\n \"name\": \"My Group\",\r\n \"description\": null,\r\n \"created_at\": \"2026-01-15T17:13:37.000000Z\",\r\n \"updated_at\": \"2026-01-15T17:13:37.000000Z\",\r\n \"deleted_at\": null\r\n }\r\n ],\r\n \"tags\": [\r\n {\r\n \"uuid\": \"ad2098a9-37e4-11f0-bffc-12c88e3f321b\",\r\n \"name\": \"My Tag\",\r\n \"description\": null,\r\n \"created_at\": \"2026-01-15T17:13:37.000000Z\",\r\n \"updated_at\": \"2026-01-15T17:13:37.000000Z\",\r\n \"deleted_at\": null\r\n }\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"{{Base-URL}}api/v5/gs1/link-templates/{{gs1_link_template_uuid}}/links","description":"This endpoint is used to create links using a GS1 link template.
\nlong_url (string): The long URL to be shortened.
assigned_attributes (array): An array of assigned attributes with UUID and value. The first UUID/value pair must be the GTIN or code attribute (required by GS1).
The response is in JSON format and follows the schema below:
\n{\n \"data\": {\n \"id\": 0,\n \"domain\": {\n \"uuid\": \"\",\n \"name\": \"\"\n },\n \"path\": \"\",\n \"short_url\": \"\",\n \"long_url\": \"\",\n \"full_url\": \"\",\n \"notes\": null,\n \"redirect_type\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"assigned_attributes\": [\n {\n \"uuid\": \"\",\n \"name\": \"\",\n \"code\": \"\",\n \"is_required_assigned\": true,\n \"value_assigned\": \"\"\n }\n ]\n }\n}\n\nThis endpoint allows you to update the details of a specific GS1 link by sending an HTTP PATCH request to the specified URL.
\nlong_url (string): The updated long URL for the link.
notes (string): Any additional notes or comments for the link.
assigned_attributes (array of objects): An array of assigned attributes with their UUID and value.
Upon successful execution, the endpoint returns a status code of 200 and a JSON object with the updated link details.
\ndata (object): Contains the updated details of the link, including its ID, domain, path, short URL, long URL, notes, and assigned attributes.Example Response:
\n{\n \"data\": {\n \"id\": 0,\n \"domain\": {\n \"uuid\": \"\",\n \"name\": \"\"\n },\n \"path\": \"\",\n \"short_url\": \"\",\n \"long_url\": \"\",\n \"full_url\": \"\",\n \"notes\": null,\n \"redirect_type\": 0,\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"assigned_attributes\": [\n {\n \"uuid\": \"\",\n \"name\": \"\",\n \"code\": \"\",\n \"is_required_assigned\": true,\n \"value_assigned\": \"\"\n }\n ]\n }\n}\n\nLists the GS1 attribute definitions available to your tenant/domain. Use this to discover each attribute’s identifier (uuid) and metadata (name, code, field_type) before creating or validating GS1 links.
This request uses the environment variable:
\n{{Base-URL}} (example in QA3: https://api.blink.app/)Full request URL:
\n{{Base-URL}}api/v5/gs1/attributes\n\nMethod: GET
Path: /api/v5/gs1/attributes
This request expects the following headers (values come from the active environment, e.g., QA3):
\n\n\nNote: The
\nAuthorizationheader is not explicitly listed in this request’s Headers tab, but the API requires a Bearer token. Ensure{{Bearer-Token}}is set in the active environment (QA3).
None.
\nA successful response returns an object with:
\ndata: array of attribute objects
uuid (string)
name (string)
code (string)
field_type (string)
links: pagination links (first, last, prev, next)
meta: pagination metadata (e.g., current_page, per_page, total, etc.)
{\n \"data\": [\n {\n \"uuid\": \"a1428ea8-f7ed-419b-b0e1-9ea5f4087924\",\n \"name\": \"GTIN\",\n \"code\": \"gtin\",\n \"field_type\": \"SINGLE_LINE_TEXT\"\n }\n ],\n \"links\": {\n \"first\": \"https://...\",\n \"last\": \"https://...\",\n \"prev\": null,\n \"next\": null\n },\n \"meta\": {\n \"current_page\": 1,\n \"per_page\": 50,\n \"total\": 1\n }\n}\n\nThis request references these environment variables:
\nBase-URL
domain_uuid
X-Tenant
Bearer-Token
Make sure the QA3 environment is selected and these variables are populated before sending the request.
\n","urlObject":{"path":["v5","gs1","attributes"],"host":["{{Base-URL}}api"],"query":[],"variable":[]}},"response":[],"_postman_id":"a2e0e24b-468c-4b1e-be3a-b3a194212cca"},{"name":"Deploy GS1 Resolver","event":[{"listen":"prerequest","script":{"id":"6ad287d3-e849-4259-a53f-53c82ec2553f","exec":["function generateRandomString(length) {"," let result = '';"," const characters = 'ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789';"," const charactersLength = characters.length;"," for (let i = 0; i < length; i++) {"," result += characters.charAt(Math.floor(Math.random() * charactersLength));"," }"," return result;","}","","function generateRandomLink() {"," const baseUrl = 'https://example.com/';"," const linkLength = 50;"," const randomString = generateRandomString(linkLength);"," const randomLink = `${baseUrl}${randomString}`;"," return randomLink;","}","","function getDomainUUid(){"," pm.sendRequest({"," url: pm.environment.get(\"Base-URL\")+'api/v5/domains',"," method: 'GET',",""," header: {"," 'Content-Type': \"application/json\","," 'X-Tenant': pm.environment.get(\"X-Tenant\"),"," 'Accept': 'application/json',"," 'Authorization': 'Bearer '+pm.environment.get(\"Bearer-Token\")"," }"," "," }, function(err, response){"," console.log(response.json())"," })","}","","getDomainUUid();","pm.environment.set(\"randomLink\", generateRandomLink());"],"type":"text/javascript","packages":{},"requests":{}}},{"listen":"test","script":{"id":"2562182d-67b9-40f7-9475-a55e41e731db","exec":["try {"," pm.test(\"Link is created\", function () {"," pm.expect(pm.response.code).to.be.oneOf([201, 202]);"," });"," var jsonData = pm.response.json()"," pm.environment.set('created_link_id',jsonData.data.id)"," pm.test('Link created successfully', function(){"," pm.expect(jsonData.message).to.eql('Link created successfully');"," pm.expect(jsonData.success).to.eql(true)"," });"," pm.test('Long url is created', function(){"," var jsonData = pm.response.json().data.longUrl"," pm.expect(jsonData).to.not.be.null;"," })","} catch (err) {"," console.log('Link not created')"," console.log(err)","}","","pm.test(\"Response status code is 201\", function () {"," pm.expect(pm.response.code).to.equal(201);","});","","","pm.test(\"Response has the required fields\", function () {"," const responseData = pm.response.json();"," "," pm.expect(responseData).to.be.an('object');"," pm.expect(responseData).to.have.property('data');"," "," const data = responseData.data;"," "," pm.expect(data).to.have.property('id');"," pm.expect(data).to.have.property('short_url');"," pm.expect(data).to.have.property('long_url');"," pm.expect(data).to.have.property('clicks');"," pm.expect(data).to.have.property('engagements');"," pm.expect(data).to.have.property('scans');"," pm.expect(data).to.have.property('redirect_type');"," pm.expect(data).to.have.property('created_at');"," pm.expect(data).to.have.property('updated_at');","});",""],"type":"text/javascript","packages":{},"requests":{}}}],"id":"cd95407f-ed3b-4d5b-ac1c-03139e98da05","protocolProfileBehavior":{"disabledSystemHeaders":{"accept":true},"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"{{Bearer-Token}}"},"isInherited":false},"method":"POST","header":[{"key":"X-Tenant","value":"{{X-Tenant}}","type":"default"},{"key":"Accept","value":"application/json","type":"default"},{"key":"X-Domain","value":"{{domain_uuid}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"type\": \"gs1resolver.json\",\n \"content\": {\n \"gs1resolver\": {\n \"@context\": \"https://gs1.org/voc/\",\n \"resolverRoot\": \"https://id.example.com\",\n \"name\": \"Example GS1 Digital Link Resolver\",\n \"supportedPrimaryKeys\": [\n \"gtin\",\n \"grai\",\n \"giai\",\n \"itip\",\n \"cpid\",\n \"gsrn\",\n \"gsrnp\"\n ],\n \"supportedLinkType\": [\n \"gs1:pip\",\n \"gs1:recipeInfo\",\n \"gs1:allergenInfo\",\n \"gs1:nutritionalInfo\",\n \"gs1:instructions\",\n \"gs1:safetyInfo\",\n \"gs1:certificationInfo\",\n \"gs1:productSustainabilityInfo\"\n ],\n \"supportedContextValuesEnumerated\": [\n \"10\",\n \"17\",\n \"21\"\n ],\n \"active\": true,\n \"uncompressedLinkType\": \"all\",\n \"defaultLinkType\": \"gs1:pip\",\n \"defaultMimeType\": \"text/html\",\n \"defaultContext\": \"xx\",\n \"defaultLanguage\": \"en\"\n }\n }\n}\n","options":{"raw":{"language":"json"}}},"url":"{{Base-URL}}api/v5/domains/{{domain_uuid}}/well-known","description":"Use this endpoint to publish a GS1 resolver descriptor (gs1resolver.json) under the .well-known path for the target domain. This enables GS1 Digital Link resolution for identifiers (e.g., GTIN, GRAI, GIAI) and related link types.
Method: POST
Path: {{Base-URL}}api/v5/domains/{{domain_uuid}}/well-known
Path variables:
\n{{domain_uuid}} – UUID of the BL.INK domain for which the GS1 resolver is being deployed.This request relies on auth configured at collection/folder level and uses environment variables.
\nRequired headers:
\nX-Tenant: {{X-Tenant}} – Tenant identifier for the BL.INK account.
X-Domain: {{domain_uuid}} – Domain UUID matching the domain_uuid in the URL.
Accept: application/json – Requests a JSON response.
The pre-request script also performs an authenticated GET {{Base-URL}}api/v5/domains call using:
Authorization: Bearer {{Bearer-Token}}Ensure the following environment variables are set in the active environment:
\n{{Base-URL}}
{{X-Tenant}}
{{domain_uuid}}
{{Bearer-Token}}
Body type: raw JSON
Content: GS1 resolver deployment payload
\n{ \"type\": \"gs1resolver.json\", \"content\": { \"gs1resolver\": { \"@context\": \"https://gs1.org/voc/ \", \"resolverRoot\": \"https://id. example.com\", \"name\": \"Example GS1 Digital Link Resolver\", \"supportedPrimaryKeys\": [ \"gtin\", \"grai\", \"giai\", \"itip\", \"cpid\", \"gsrn\", \"gsrnp\" ], \"supportedLinkType\": [ \"gs1:pip\", \"gs1:recipeInfo\", \"gs1:allergenInfo\", \"gs1:nutritionalInfo\", \"gs1:instructions\", \"gs1:safetyInfo\", \"gs1:certificationInfo\", \"gs1:productSustainabilityInf o\" ], \"supportedContextValuesEnumerated \": [ \"10\", \"17\", \"21\" ], \"active\": true, \"uncompressedLinkType\": \"all\", \"defaultLinkType\": \"gs1:pip\", \"defaultMimeType\": \"text/html\", \"defaultContext\": \"xx\", \"defaultLanguage\": \"en\" } }}\n\ntype: Must be \"gs1resolver.json\"; indicates this is a GS1 resolver configuration document.
content.gs1resolver.@context: JSON-LD context for GS1 vocabulary (https://gs1.org/voc/).
content.gs1resolver.resolverRoot: Base URL of your GS1 Digital Link resolver (the root that will serve resolved links).
\ncontent.gs1resolver.name: Human-readable name for this resolver instance.
\ncontent.gs1resolver.supportedPrimaryKeys: Array of GS1 identifier types that this resolver supports (e.g., gtin, grai).
content.gs1resolver.supportedLinkType: Array of GS1 link types that the resolver can return (e.g., gs1:pip, gs1:nutritionalInfo).
content.gs1resolver.supportedContextValuesEnumerated: Context values that this resolver recognizes (e.g., application identifiers).
\ncontent.gs1resolver.active: When true, marks this resolver configuration as active.
content.gs1resolver.uncompressedLinkType: Controls how link types are represented (e.g., \"all\" to allow all link types).
content.gs1resolver.defaultLinkType: Default link type to use when the request does not specify one (e.g., \"gs1:pip\").
content.gs1resolver.defaultMimeType: Default MIME type returned when none is specified (e.g., \"text/html\").
content.gs1resolver.defaultContext: Default context value used when none is supplied by the client.
\ncontent.gs1resolver.defaultLanguage: Default language code (e.g., \"en\") for resolver responses.
Imports multiple links into BL.INK in bulk using a CSV file.
\nCollection: BL.INK V5 Public API
\nRequest name: Import Links
\nEndpoint: {{Base-URL}}api/v4/imports
Method: POST
Content type: multipart/form-data
Use this endpoint to upload a file of links that will be processed asynchronously. You can later check the status of the import with the related “Link Import Status” endpoint.
\n{{Base-URL}}api/v4/imports\n\n{{Base-URL}} is provided by your environment (e.g., the Prod EU environment).
POST\n\nThese headers are configured on the request:
\nContent-Type: multipart/form-data
Handled automatically by Postman when you configure form-data body fields.
X-Tenant: {{X-Tenant}}
Identifies the tenant context in BL.INK.
\n{{X-Tenant}} should be set in the active environment (e.g., Prod EU).
Authentication is typically configured at the collection or environment level using a Bearer token:
\nAuthorization: Bearer {{Bearer-Token}}\n\nMake sure {{Bearer-Token}} is set to a valid access token for your tenant.
The request body uses form-data:
domain_id
Type: text / number
\nRequired: Yes
\nDescription: The numeric ID of the BL.INK domain into which the links will be imported.
\nExample: 2
upload
Type: file
\nRequired: Yes
\nDescription: The CSV (or supported file format) containing the list of links to import.
\nNotes:
\nMust follow the expected column layout for your BL.INK account.
\nFile size and row-count limits may apply depending on your tenant configuration.
\nOn a successful import request, the API returns 201 Created.
The response body contains a data object with fields similar to:
{\n \"data\": {\n \"id\": \"...\",\n \"domain\": \"...\",\n \"path\": \"...\",\n \"short_url\": \"...\",\n \"long_url\": \"...\",\n \"full_url\": \"...\",\n \"notes\": \"...\",\n \"redirect_type\": \"...\",\n \"created_at\": \"...\",\n \"updated_at\": \"...\",\n \"assigned_attributes\": { }\n }\n}\n\nThe existing tests validate that:
\nStatus code is 201.
response.data includes the properties:
id
domain
path
short_url
long_url
full_url
notes
redirect_type
created_at
updated_at
assigned_attributes
Response time is less than 3000ms.
Exact payloads can vary by deployment, but typical error conditions include:
\n400 Bad Request
\nInvalid or malformed CSV/file.
\nMissing required form fields (domain_id or upload).
Invalid domain_id or unsupported field values in the file.
401 Unauthorized / 403 Forbidden
\nMissing, expired, or invalid Bearer token.
\nToken does not have permission to import links for the specified tenant or domain.
\n404 Not Found
\n5xx Server Errors
\nRun this request against your desired environment (for production, use the Prod EU environment).
Ensure that:
\n{{Base-URL}}, {{X-Tenant}}, and {{Bearer-Token}} are correctly set in the active environment.
Your CSV structure matches the BL.INK import specification for your account.
\nUse the Link Import Status endpoint to check the processing status of the uploaded file if your workflow supports asynchronous import tracking.
\nChecks the status and result of a bulk link import job.
\nUse this endpoint after running Import Links to retrieve the current status and final result of a specific import job. It returns metadata about the imported link and related attributes once processing is complete.
\nGET {{Base-URL}}api/v4/imports/{{link_import_job_id}}
{{Bearer-Token}}).Content-Type: application/jsonX-Tenant: {{X-Tenant}}{{link_import_job_id}} – The unique identifier of the link import job returned by the Import Links request. Use this value to poll or fetch the job status.Tests for this request currently expect:
\n201 Createddata property.data is an object representing the imported link with fields such as:iddomainpathshort_urllong_urlfull_urlnotesredirect_typecreated_atupdated_atassigned_attributeslink_import_job_id.{{link_import_job_id}} to check processing status and retrieve details of the imported link(s).This endpoint retrieves the dynamic link rules associated with a specific domain identified by the domain_uuid. It provides information about various parameters such as country, language, browser compatibility, operating systems, and device types.
Method: GET
\nURL: {{Base-URL}}api/v5/domains/{{domain_uuid}}/dynamic-links/rules
domain_uuid (string): The unique identifier for the domain whose dynamic link rules are being requested.On a successful request (HTTP Status 200), the response will be in JSON format and will contain the following structure:
\n{\n \"data\": {\n \"country\": [\n {\n \"code\": \"string\",\n \"name\": \"string\",\n \"regions\": [\"array of strings\"]\n }\n ],\n \"language\": [\n {\n \"value\": \"string\",\n \"caption\": \"string\",\n \"dialects\": [\"array of strings\"]\n }\n ],\n \"browser\": {\n \"Chrome\": \"string\",\n \"Dolfin\": \"string\",\n \"Opera\": \"string\",\n \"Skyfire\": \"string\",\n \"Edge\": \"string\",\n \"IE\": \"string\",\n \"Firefox\": \"string\",\n \"Bolt\": \"string\",\n \"TeaShark\": \"string\",\n \"Blazer\": \"string\",\n \"Safari\": \"string\",\n \"WeChat\": \"string\",\n \"UCBrowser\": \"string\",\n \"baiduboxapp\": \"string\",\n \"baidubrowser\": \"string\",\n \"DiigoBrowser\": \"string\",\n \"Mercury\": \"string\",\n \"NetFront\": \"string\",\n \"GenericBrowser\": \"string\",\n \"PaleMoon\": \"string\"\n },\n \"operating_system\": {\n \"iOS\": \"string\",\n \"AndroidOS\": \"string\",\n \"Windows\": \"string\",\n \"MacOS\": \"string\",\n \"Linux\": \"string\",\n \"IPadOS\": \"string\",\n \"Other\": \"string\"\n },\n \"device\": {\n \"mobile\": [\"array of strings\"],\n \"laptop\": [\"array of strings\"],\n \"tablet\": [\"array of strings\"]\n }\n }\n}\n\ndata: An object containing:
\ncountry: An array of country objects, each with:
\ncode: The country code.
name: The name of the country.
regions: An array of regions within the country.
language: An array of language objects, each with:
\nvalue: The language value.
caption: A caption for the language.
dialects: An array of dialects for the language.
browser: An object mapping browser names to their respective values.
\noperating_system: An object mapping operating system names to their respective values.
\ndevice: An object containing arrays for different device types (mobile, laptop, tablet).
\nThis endpoint is essential for understanding the compatibility and rules for dynamic links based on various user parameters.
\n","urlObject":{"path":["v5","domains","{{domain_uuid}}","dynamic-links","rules"],"host":["{{Base-URL}}api"],"query":[],"variable":[]}},"response":[],"_postman_id":"8f6a3ab5-e558-4ed4-b2cb-f7b8491f4931"},{"name":"Show Dynamic Link Rules","id":"3fb92128-a326-4ade-a05e-987a70bf57bd","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"{{Bearer-Token}}"},"isInherited":false},"method":"GET","header":[{"key":"X-Tenant","value":"{{X-Tenant}}","type":"text"},{"key":"X-Domain","value":"{{domain_uuid}}","type":"text"}],"url":"{{Base-URL}}api/v5/domains/{{domain_uuid}}/{{link_id}}/dynamic-links","description":"This endpoint allows you to retrieve dynamic links associated with a specific domain and link identifier.
\n{{Base-URL}}api/v5/domains/{{domain_uuid}}/{{link_id}}/dynamic-linksdomain_uuid (string): The unique identifier for the domain.
link_id (string): The unique identifier for the specific link.
On a successful request, the API will return a response with a status code of 200 and a content type of application/json. The response body will contain the following structure:
\n{\n \"data\": [\n {\n \"uuid\": \"\",\n \"long_url\": \"\",\n \"order\": 0,\n \"rules\": [\n {\n \"uuid\": \"\",\n \"type\": \"\",\n \"operation\": \"\",\n \"order\": 0,\n \"primary_value\": \"\",\n \"secondary_value\": \"\"\n }\n ]\n }\n ]\n}\n\ndata: An array containing dynamic link objects.
\nuuid: The unique identifier for the dynamic link.
\nlong_url: The original long URL that the dynamic link points to.
\norder: The order of the dynamic link in the list.
\nrules: An array of rules associated with the dynamic link.
\nuuid: The unique identifier for the rule.
\ntype: The type of rule.
\noperation: The operation defined by the rule.
\norder: The order of the rule in the list.
\nprimary_value: The primary value associated with the rule.
\nsecondary_value: The secondary value associated with the rule.
\nThis endpoint is useful for managing and retrieving dynamic links for a specific domain, allowing for effective link tracking and management.
\n","urlObject":{"path":["v5","domains","{{domain_uuid}}","{{link_id}}","dynamic-links"],"host":["{{Base-URL}}api"],"query":[],"variable":[]}},"response":[],"_postman_id":"3fb92128-a326-4ade-a05e-987a70bf57bd"},{"name":"Create Dynamic Link","id":"c43f93e3-052d-485f-935d-425d177d25b6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"{{Bearer-Token}}"},"isInherited":false},"method":"POST","header":[{"key":"X-Tenant","value":"{{X-Tenant}}","type":"text"},{"key":"X-Domain","value":"{{domain_uuid}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"long_url\": \"http://blink.com\", //required\n \"order\": 4, //required\n \"rules\": [\n {\n \"rule_type\": \"device\", //required\n \"rule_operator\": \"is\", //required\n \"rule_order\": 1, //required\n \"rule_primary_value\": \"desktop\", //required\n \"rule_secondary_value\": \"2025-08-01 23:59:59\" //optional but required for some date rules type\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"{{Base-URL}}api/v5/domains/{{domain_uuid}}/{{link_id}}/dynamic-links","description":"This endpoint allows you to create a dynamic link for a specified domain. By sending a POST request to the endpoint, you can define a long URL that the dynamic link will redirect to, along with specific rules that govern when and how the link should be activated.
\nThe request body must be in JSON format and should include the following parameters:
\nlong_url (string): The URL to which the dynamic link will redirect. This should be a valid URL format.
\norder (integer): An integer value that determines the order of the dynamic link among others.
\nrules (array): An array of rule objects that specify conditions under which the dynamic link is active. Each rule object can contain the following keys:
\nrule_type (string): The type of rule being applied (e.g., device).
\nrule_operator (string): The operator used for the rule (e.g., is).
\nrule_order (integer): The order of this specific rule.
\nrule_primary_value (string): The primary value for the rule condition (e.g., device type such as 'desktop').
\nrule_secondary_value (string): An optional secondary value that may be used for additional conditions (e.g., a date).
\nUpon a successful request, the server responds with a status code of 200 and returns the following JSON structure:
\ndata (array): An array containing the details of the created dynamic link. Each object in the array includes:
\nuuid (string): A unique identifier for the dynamic link.
\nlong_url (string): The long URL that the dynamic link points to.
\norder (integer): The order of the dynamic link.
\nrules (array): An array of rule objects associated with the dynamic link, each containing:
\nuuid (string): A unique identifier for the rule.
\ntype (string): The type of the rule.
\noperation (string): The operation defined by the rule.
\norder (integer): The order of the rule.
\nprimary_value (string): The primary value for the rule condition.
\nsecondary_value (string): The secondary value for the rule condition.
\nThis endpoint is essential for managing dynamic links that can adapt based on user-defined rules, enhancing the flexibility and targeting of URL redirections.
\n","urlObject":{"path":["v5","domains","{{domain_uuid}}","{{link_id}}","dynamic-links"],"host":["{{Base-URL}}api"],"query":[],"variable":[]}},"response":[],"_postman_id":"c43f93e3-052d-485f-935d-425d177d25b6"},{"name":"Delete Dynamic Link","id":"8b680bd7-24dc-4509-9281-71cb1dcfd01c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"{{Bearer-Token}}"},"isInherited":false},"method":"DELETE","header":[{"key":"X-Tenant","value":"{{X-Tenant}}","type":"text"},{"key":"X-Domain","value":"{{domain_uuid}}","type":"text"}],"url":"{{Base-URL}}api/v5/domains/{{domain_uuid}}/{{link_id}}/dynamic-links/{{rule_uuid}}","description":"This endpoint allows the user to delete a specific dynamic link rule associated with a domain. The request targets a particular dynamic link rule identified by its rule_uuid, which is nested under a specific domain and link identified by domain_uuid and link_id, respectively.
Method: DELETE
\nURL: {{Base-URL}}api/v5/domains/{{domain_uuid}}/{{link_id}}/dynamic-links/{{rule_uuid}}
Request Body: This request does not require a body.
\nUpon successful deletion, the server will respond with a confirmation message indicating that the dynamic link rule has been deleted. The response will typically be in JSON format, confirming the action taken.
\nEnsure that the domain_uuid, link_id, and rule_uuid are valid and correspond to existing resources within the system to avoid errors.
This endpoint allows you to update a specific dynamic link rule associated with a domain. By sending a PATCH request to the specified URL, you can modify the properties of an existing dynamic link rule identified by its rule_uuid.
The request body must be in JSON format and include the following parameters:
\nlong_url (string): The new long URL that the dynamic link will redirect to.
\norder (integer): The order in which the rule should be applied.
\nrules (array): An array of rule objects that define the conditions under which the dynamic link will be activated. Each rule object can contain:
\nrule_type (string): The type of the rule (e.g., device).
\nrule_operator (string): The operator used for the rule condition (e.g., is).
\nrule_order (integer): The order of this specific rule.
\nrule_primary_value (string): The primary value for the rule condition (e.g., phone).
\nrule_secondary_value (string): An optional secondary value for the rule condition (e.g., a date or additional parameter).
\nUpon a successful update, the API will return a 200 OK status with a JSON response containing the updated dynamic link information. The response structure includes:
data (array): An array of objects representing the updated dynamic links. Each object includes:
\nuuid (string): The unique identifier for the dynamic link.
\nlong_url (string): The updated long URL.
\norder (integer): The order of the dynamic link.
\nrules (array): The updated rules associated with the dynamic link, each containing:
\nuuid (string): The unique identifier for the rule.
\ntype (string): The type of the rule.
\noperation (string): The operation used in the rule.
\norder (integer): The order of the rule.
\nprimary_value (string): The primary value for the rule.
\nsecondary_value (string): The secondary value for the rule.
\nEnsure that the domain_uuid, link_id, and rule_uuid in the URL are correctly specified to target the appropriate dynamic link rule.
The request body must adhere to the specified structure to avoid errors during processing.
\nThis endpoint retrieves the details of a specific dynamic link rule associated with a particular domain and link. It allows users to access the properties and configurations of the rule identified by the rule_uuid.
Method: GET
\nEndpoint: {{Base-URL}}api/v5/domains/{{domain_uuid}}/{{link_id}}/dynamic-links/rules/{{rule_uuid}}
Path Parameters:
\ndomain_uuid: The unique identifier for the domain.
link_id: The unique identifier for the link.
rule_uuid: The unique identifier for the dynamic link rule.
Status Code: 200 OK
\nContent-Type: application/json
\n{ \"data\": { \"uuid\": \"\", // Unique identifier for the rule \"type\": \"\", // Type of the dynamic link rule \"operation\": \"\", // Operation performed by the rule \"order\": 0, // Order of execution for the rule \"primary_value\": \"\", // Primary value associated with the rule \"secondary_value\": \"\" // Secondary value associated with the rule }}
\nThe response contains a data object that provides details about the dynamic link rule, including its unique identifier, type, operation, execution order, and associated values.
This endpoint allows you to update the rules for dynamic links associated with a specific domain. The request modifies an existing rule identified by rule_uuid for a given link_id under the specified domain_uuid.
{{Base-URL}}api/v5/domains/{{domain_uuid}}/{{link_id}}/dynamic-links/rules/{{rule_uuid}}The request body must be sent in JSON format and should include the following parameters:
\nrule_type (string): Specifies the type of rule being applied (e.g., \"day_of_week\").
\nrule_operator (string): Defines the operator for the rule (e.g., \"is\").
\nrule_order (integer): Indicates the order of the rule (e.g., 1).
\nrule_primary_value (string): The primary value for the rule (e.g., \"friday\").
\nExample of a request body:
\n{\n \"rule_type\": \"day_of_week\",\n \"rule_operator\": \"is\",\n \"rule_order\": 1,\n \"rule_primary_value\": \"friday\"\n}\n\nOn a successful request, the server will respond with a status code of 200 and the content type will be application/json. The response will contain the following structure:
{\n \"data\": {\n \"uuid\": \"\",\n \"type\": \"\",\n \"operation\": \"\",\n \"order\": 0,\n \"primary_value\": \"\",\n \"secondary_value\": \"\"\n }\n}\n\nuuid, type, operation, order, primary_value, and secondary_value.This endpoint is essential for managing dynamic link rules effectively, allowing for the customization of link behavior based on specified criteria.
\n","urlObject":{"path":["v5","domains","{{domain_uuid}}","{{link_id}}","dynamic-links","rules","{{rule_uuid}}"],"host":["{{Base-URL}}api"],"query":[],"variable":[]}},"response":[],"_postman_id":"b601c481-5c61-4421-9d0c-5be52acf6009"},{"name":"Delete Dynamic Link Rule","id":"b2c1fee5-81de-4d40-b6b1-04441aaa9af9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"{{Bearer-Token}}"},"isInherited":false},"method":"DELETE","header":[{"key":"X-Tenant","value":"{{X-Tenant}}","type":"text"},{"key":"X-Domain","value":"{{domain_uuid}}","type":"text"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"{{Base-URL}}api/v5/domains/{{domain_uuid}}/{{link_id}}/dynamic-links/rules/{{rule_uuid}}","description":"This endpoint allows you to delete a specific dynamic link rule associated with a given domain and link.
\nDELETE
{{Base-URL}}api/v5/domains/{{domain_uuid}}/{{link_id}}/dynamic-links/rules/{{rule_uuid}}
domain_uuid: The unique identifier for the domain.
link_id: The unique identifier for the specific link.
rule_uuid: The unique identifier for the dynamic link rule you wish to delete.
Upon successful deletion, the API will return a response indicating the success of the operation. The expected response format is typically a JSON object confirming the deletion, but the exact structure may vary.
\nEnsure that you have the necessary permissions to delete the specified rule, as unauthorized requests will result in an error response.
\n","urlObject":{"path":["v5","domains","{{domain_uuid}}","{{link_id}}","dynamic-links","rules","{{rule_uuid}}"],"host":["{{Base-URL}}api"],"query":[],"variable":[]}},"response":[],"_postman_id":"b2c1fee5-81de-4d40-b6b1-04441aaa9af9"}],"id":"22797b55-3640-43b3-9f35-e90108c647aa","_postman_id":"22797b55-3640-43b3-9f35-e90108c647aa","description":""},{"name":"Link Templates","item":[{"name":"List Templates","event":[{"listen":"test","script":{"id":"41bcbc2f-95a9-48a4-b9e0-b06a3aa9f31f","exec":["// Test for status code","pm.test(\"Status code is 200\", function () {"," pm.response.to.have.status(200);","});","","// Test for response body properties","pm.test(\"Response body has data array\", function () {"," const responseBody = pm.response.json();"," pm.expect(responseBody).to.have.property('data').that.is.an('array');","});","","pm.test(\"Each link template has uuid, name, and is_gs1_template\", function () {"," const responseBody = pm.response.json();"," responseBody.data.forEach((template) => {"," pm.expect(template).to.have.property('uuid').that.is.a('string');"," pm.expect(template).to.have.property('name').that.is.a('string');"," pm.expect(template).to.have.property('is_gs1_template').that.is.a('boolean');"," });","});",""],"type":"text/javascript","packages":{}}}],"id":"8d12276b-37c3-4a04-94e9-11b6ee173aac","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"{{Bearer-Token}}"},"isInherited":false},"method":"GET","header":[{"key":"X-Domain","value":"{{domain_uuid}}","type":"text"},{"key":"X-Tenant","value":"{{X-Tenant}}","type":"text"}],"url":"{{Base-URL}}api/v5/link-templates","description":"This endpoint is used to retrieve all link templates.
\nThis is a GET request and does not require a request body.
\nThe response is in JSON format and contains an array of link templates with the following properties:
\nuuid (string): The UUID of the link template.
name (string): The name of the link template.
is_gs1_template (boolean): Indicates whether the template is a GS1 template.
Example:
\n{\n \"data\": [\n {\n \"uuid\": \"\",\n \"name\": \"\",\n \"is_gs1_template\": true\n }\n ]\n}\n\nThis endpoint retrieves attributes for a specific GS1 link template identified by the UUID.
\nNo request body is required for this endpoint.
\nThe response is in JSON format and contains an array of objects with the following attributes:
\nuuid (string): The UUID of the attribute.
name (string): The name of the attribute.
code (string): The code of the attribute.
has_options (boolean): Indicates if the attribute has options.
field_type (string): The type of the field.
is_required_template (boolean): Indicates if the attribute is required.
default_value_template (string): The default value assigned to the attribute.
options (array): An array of options for the attribute.
{\n \"data\": [\n {\n \"uuid\": \"\",\n \"name\": \"\",\n \"code\": \"\",\n \"has_options\": true,\n \"field_type\": \"\",\n \"is_required_template\": true,\n \"default_value_template\": null,\n \"options\": []\n }\n ]\n}\n\n{\n \"type\": \"object\",\n \"properties\": {\n \"data\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"object\",\n \"properties\": {\n \"uuid\": { \"type\": \"string\" },\n \"name\": { \"type\": \"string\" },\n \"code\": { \"type\": \"string\" },\n \"has_options\": { \"type\": \"boolean\" },\n \"field_type\": { \"type\": \"string\" },\n \"is_required_template\": { \"type\": \"boolean\" },\n \"default_value_template\": { \"type\": \"string\" },\n \"options\": { \"type\": \"array\" }\n }\n }\n }\n }\n}\n\nThe endpoint retrieves the QR templates associated with a specific domain using an HTTP GET request to {{Base-URL}}api/v5/domains/{{domain_uuid}}/qr-templates.
No request body is required for this endpoint.
\nThe response for this request can be represented as a JSON schema:
\n{\n \"type\": \"object\",\n \"properties\": {\n \"data\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"object\",\n \"properties\": {\n \"uuid\": { \"type\": \"string\" },\n \"name\": { \"type\": \"string\" },\n \"description\": { \"type\": \"string\" },\n \"width\": { \"type\": \"string\" },\n \"height\": { \"type\": \"string\" }\n }\n }\n },\n \"links\": {\n \"type\": \"object\",\n \"properties\": {\n \"first\": { \"type\": \"string\" },\n \"last\": { \"type\": \"string\" },\n \"prev\": { \"type\": [\"string\", \"null\"] },\n \"next\": { \"type\": [\"string\", \"null\"] }\n }\n },\n \"meta\": {\n \"type\": \"object\",\n \"properties\": {\n \"current_page\": { \"type\": \"integer\" },\n \"from\": { \"type\": \"integer\" },\n \"last_page\": { \"type\": \"integer\" },\n \"links\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"object\",\n \"properties\": {\n \"url\": { \"type\": [\"string\", \"null\"] },\n \"label\": { \"type\": \"string\" },\n \"active\": { \"type\": \"boolean\" }\n }\n }\n },\n \"path\": { \"type\": \"string\" },\n \"per_page\": { \"type\": \"integer\" },\n \"to\": { \"type\": \"integer\" },\n \"total\": { \"type\": \"integer\" }\n }\n }\n }\n}\n\nThis endpoint retrieves a QR code in the specified format (SVG / PNG / EPS) for a link within a domain. The QR code is generated based on the provided QR Template UUID.
\nMethod: GET
URL: {{Base-URL}}api/v5/domains/{{domain_uuid}}/links/{{link_id}}/qr/?template_id={{qr_template_id}}&format={{qr_output_format}}
{\n \"type\": \"object\",\n \"properties\": {\n \"qr_code\": {\n \"type\": \"string\",\n \"description\": \"The SVG format QR code for the specific link\"\n }\n }\n}\n\nThe UUID of your QR Template
\n","type":"text/plain"},"key":"template_id","value":"{{qr_template_id}}"},{"description":{"content":"svg/eps/png
\n","type":"text/plain"},"key":"format","value":"{{qr_output_format}}"}],"variable":[]}},"response":[{"id":"3c02f44b-19cf-4f2d-aae9-4f2f923d1a7f","name":"Get QR from Link with Template","originalRequest":{"method":"GET","header":[{"key":"X-Tenant","value":"{{X-Tenant}}","type":"text"}],"url":{"raw":"{{Base-URL}}api/v5/domains/{{domain_uuid}}/links/{{link_id}}/qr?template_id={{qr_template_id}}&format={{qr_output_format}}","host":["{{Base-URL}}api"],"path":["v5","domains","{{domain_uuid}}","links","{{link_id}}","qr"],"query":[{"key":"template_id","value":"{{qr_template_id}}","description":"The ID for the link template"},{"key":"format","value":"{{qr_output_format}}","description":"SVG / PNG / EPS"}]}},"status":"OK","code":200,"_postman_previewlanguage":null,"header":[{"key":"Server","value":"awselb/2.0","enabled":true},{"key":"Content-Type","value":"text/html; charset=UTF-8","enabled":true},{"key":"Content-Length","value":"226131","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true},{"key":"Vary","value":"Origin","enabled":true},{"key":"Date","value":"Tue, 12 Aug 2025 20:26:13 GMT","enabled":true},{"key":"Expires","value":"0","enabled":true},{"key":"Pragma","value":"no-cache","enabled":true},{"key":"Cache-Control","value":"must-revalidate, no-cache, no-store, private","enabled":true},{"key":"Content-Disposition","value":"attachment; filename=meal.svg","enabled":true}],"cookie":[],"responseTime":null,"body":"\n