Skip to content

/v1/marketing-qr-codes (GET)

GET
/v1/marketing-qr-codes
curl --request GET \
--url 'https://example.com/v1/marketing-qr-codes?limit=20&offset=0' \
--header 'Authorization: Bearer <token>'
workspace_id
string format: uuid
limit
integer
default: 20 >= 1 <= 100
offset
integer | null
0

Marketing QR codes visible to the caller

Media typeapplication/json
object
items
required
Array<object>
<= 200 items
object
id
required
string format: uuid
workspace_id
required
string format: uuid
name
required
string | null
<= 2000 characters
url
required
string | null
<= 2000 characters
short_url
required
string | null
<= 2000 characters
is_published
required
boolean | null
published_at
required
string | null
<= 2000 characters
expires_at
required
string | null
<= 2000 characters
expired_url
required
string | null
<= 2000 characters
ios_url
required
string | null
<= 2000 characters
android_url
required
string | null
<= 2000 characters
notes
required
string | null
<= 2000 characters
utm_source
required
string | null
<= 2000 characters
utm_medium
required
string | null
<= 2000 characters
utm_campaign
required
string | null
<= 2000 characters
utm_term
required
string | null
<= 2000 characters
utm_content
required
string | null
<= 2000 characters
geo_count
required
integer | null
created_at
required
string | null
<= 2000 characters
updated_at
required
string | null
<= 2000 characters
limit
required
integer
offset
required
integer
total
required
integer
Examplegenerated
{
"items": [
{
"id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
"workspace_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
"name": "example",
"url": "example",
"short_url": "example",
"is_published": true,
"published_at": "example",
"expires_at": "example",
"expired_url": "example",
"ios_url": "example",
"android_url": "example",
"notes": "example",
"utm_source": "example",
"utm_medium": "example",
"utm_campaign": "example",
"utm_term": "example",
"utm_content": "example",
"geo_count": 1,
"created_at": "example",
"updated_at": "example"
}
],
"limit": 1,
"offset": 1,
"total": 1
}

Invalid query parameters

Media typeapplication/problem+json
object
type
required
string
<= 2000 characters
title
required
string
<= 2000 characters
status
required
number
detail
string
<= 2000 characters
Examplegenerated
{
"type": "example",
"title": "example",
"status": 1,
"detail": "example"
}

Missing or invalid bearer token

Media typeapplication/problem+json
object
type
required
string
<= 2000 characters
title
required
string
<= 2000 characters
status
required
number
detail
string
<= 2000 characters
Examplegenerated
{
"type": "example",
"title": "example",
"status": 1,
"detail": "example"
}

Upstream error

Media typeapplication/problem+json
object
type
required
string
<= 2000 characters
title
required
string
<= 2000 characters
status
required
number
detail
string
<= 2000 characters
Examplegenerated
{
"type": "example",
"title": "example",
"status": 1,
"detail": "example"
}