API reference

This page is generated from the public OpenAPI source file.

• Source: docs/api/openapi/bytes-developer-api.openapi.yaml
• Published spec: /openapi/bytes-developer-api.openapi.yaml The reference below only includes deliberate public /api/v1/* endpoints. Browser-session, admin, billing, domain and analytics routes are intentionally not included.

Endpoints

Method	Path	Summary
GET	/activity-groups	List Activity Groups
GET	/links	List short links
POST	/links	Create a short link
GET	/links/:id	Get a short link
PATCH	/links/:id	Update a short link
DELETE	/links/:id	Delete a short link
GET	/links/:id/qr	Retrieve a Link QR
POST	/links/:id/tags	Attach tags to a link
DELETE	/links/:id/tags/:tagId	Remove a tag from a link
GET	/tags	List workspace tags
POST	/tags	Create a workspace tag
PATCH	/tags/:id	Update a workspace tag
DELETE	/tags/:id	Delete a workspace tag

GET /activity-groups

|

• Operation ID: listActivityGroups
• Authentication: Bearer API key
• Request body: none

Responses

Status	Description
200	Activity Groups returned.
401	Response
404	Response
422	Response

See the OpenAPI source for schemas, examples and validation rules.

GET /links

Lists short links in the workspace that owns the API key.

• Operation ID: listLinks
• Authentication: Bearer API key
• Request body: none

Responses

Status	Description
200	Links returned.
401	Response
404	Response

See the OpenAPI source for schemas, examples and validation rules.

POST /links

|

• Operation ID: createLink
• Authentication: Bearer API key
• Request body: CreateLinkRequest

Responses

Status	Description
201	Short link created successfully.
401	Response
404	Response
422	Validation, Activity Group, limit, slug or destination safety error.

See the OpenAPI source for schemas, examples and validation rules.

GET /links/:id

Returns one short link from the workspace that owns the API key.

• Operation ID: getLink
• Authentication: Bearer API key
• Request body: none

Responses

Status	Description
200	Link returned.
401	Response
404	Workspace or link not found.

See the OpenAPI source for schemas, examples and validation rules.

PATCH /links/:id

|

• Operation ID: updateLink
• Authentication: Bearer API key
• Request body: UpdateLinkRequest

Responses

Status	Description
200	Link updated successfully.
401	Response
404	Workspace or link not found.
422	Validation, Activity Group, limit, slug or destination safety error.

See the OpenAPI source for schemas, examples and validation rules.

DELETE /links/:id

Soft-deletes one short link in the workspace that owns the API key.

• Operation ID: deleteLink
• Authentication: Bearer API key
• Request body: none

Responses

Status	Description
204	Link deleted successfully. No response body is returned.
401	Response
404	Workspace or link not found.
422	Link cannot be deleted because it is attached to a live Offline Engagement asset.

See the OpenAPI source for schemas, examples and validation rules.

GET /links/:id/qr

|

• Operation ID: getLinkQr
• Authentication: Bearer API key
• Request body: none

Responses

Status	Description
200	Governed safe Link QR file.
401	Response
404	Workspace or Link not found, including cross-workspace or archived/deleted Links.
422	Invalid format, size, unsupported parameter or QR output safety error.

See the OpenAPI source for schemas, examples and validation rules.

POST /links/:id/tags

Attaches one or more workspace tags to a link.

• Operation ID: attachTagsToLink
• Authentication: Bearer API key
• Request body: AttachTagsRequest

Responses

Status	Description
200	Tags attached successfully.
401	Response
404	Workspace or link not found.
422	Response

See the OpenAPI source for schemas, examples and validation rules.

DELETE /links/:id/tags/:tagId

Removes one workspace tag from one link.

• Operation ID: detachTagFromLink
• Authentication: Bearer API key
• Request body: none

Responses

Status	Description
204	Tag removed from link. No response body is returned.
401	Response
404	Workspace, link or tag not found.

See the OpenAPI source for schemas, examples and validation rules.

GET /tags

Lists tags for the workspace that owns the API key.

• Operation ID: listTags
• Authentication: Bearer API key
• Request body: none

Responses

Status	Description
200	Tags returned.
401	Response
404	Response

See the OpenAPI source for schemas, examples and validation rules.

POST /tags

Creates a tag in the workspace that owns the API key.

• Operation ID: createTag
• Authentication: Bearer API key
• Request body: CreateTagRequest

Responses

Status	Description
201	Tag created successfully.
401	Response
404	Response
422	Response

See the OpenAPI source for schemas, examples and validation rules.

PATCH /tags/:id

Updates a tag in the workspace that owns the API key.

• Operation ID: updateTag
• Authentication: Bearer API key
• Request body: UpdateTagRequest

Responses

Status	Description
200	Tag updated successfully.
401	Response
404	Workspace or tag not found.
422	Response

See the OpenAPI source for schemas, examples and validation rules.

DELETE /tags/:id

Deletes a tag from the workspace and removes it from links.

• Operation ID: deleteTag
• Authentication: Bearer API key
• Request body: none

Responses

Status	Description
204	Tag deleted successfully. No response body is returned.
401	Response
404	Workspace or tag not found.

See the OpenAPI source for schemas, examples and validation rules.

Regenerating this page

Run this from the repository root:

cd docs/public
npm run generate-api-reference
cd ../..

The docs build also regenerates this page automatically before Docusaurus builds the site.