Skip to main content
GET
/
v1
/
workspaces
/
{workspace_id}
/
links
/
{link_id}
/
qr-code
Get QR code customization
curl --request GET \
  --url https://api.ziplink.click/v1/workspaces/{workspace_id}/links/{link_id}/qr-code \
  --header 'Authorization: Bearer <token>'
{
  "border": 0,
  "color": "#000000",
  "created_at": "2023-11-07T05:31:56Z",
  "id": "ab782971-4d79-47ab-8685-77cf5a34b2bb",
  "link_id": "ab782971-4d79-47ab-8685-77cf5a34b2bb",
  "logo_url": "https://example.com/2024-conference-dubai.png",
  "path": "/ab782971-4d79-47ab-8685-77cf5a34b2bb/qr-code.123456789.png",
  "updated_at": "2023-11-07T05:31:56Z"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
workspace_id
string<uuid>
required

ID of the workspace.

Example:

"ab782971-4d79-47ab-8685-77cf5a34b2bb"

​
link_id
string<uuid>
required

ID of the link.

Example:

"ab782971-4d79-47ab-8685-77cf5a34b2bb"

Response

OK

​
border
integer
required

Border width of the QR code frame.

Required range: 0 <= x <= 100
Example:

0

​
color
string
required

HEX color code of the foreground color.

Required string length: 7
Example:

"#000000"

​
created_at
string<date-time> | null
required

Date when the link was created.

​
id
string | null
required

Globally unique identifier of the QR code customization.

Example:

"ab782971-4d79-47ab-8685-77cf5a34b2bb"

​
link_id
string
required

Globally unique identifier of the link the QR code belongs to.

Example:

"ab782971-4d79-47ab-8685-77cf5a34b2bb"

​
logo_url
string<uri> | null
required

URL of the logo, if empty, the Ziplink logo is used.

Maximum length: 2000
Example:

"https://example.com/2024-conference-dubai.png"

​
path
string<uri>
required

Path of the QR code.

Maximum length: 2000
Example:

"/ab782971-4d79-47ab-8685-77cf5a34b2bb/qr-code.123456789.png"

​
updated_at
string<date-time> | null
required

Date when the link was updated.