Media API Reference

#The Media object

Media represents a media file in the system

createdAt

string (date-time)

fileName

string

mediaType

string (enum)

- TYPE_UNSPECIFIED: The media type is not specified - TYPE_CENTRAL_QRCODE_IMAGE: The media type is a central QR code image

Allowed values

TYPE_UNSPECIFIED

The media type is not specified

TYPE_CENTRAL_QRCODE_IMAGE

The media type is a central QR code image

mimeType

string

signedUrl

string

size

string (int64)

updatedAt

string (date-time)

uploadedBy

string

The member who uploaded the file If it was uploaded through the public API, or if the member was removed from the workspace, the uploaded_by will be null.

visibility

string (enum)

- VISIBILITY_UNSPECIFIED: The media visibility is not specified - VISIBILITY_PUBLIC: The media visibility is public - VISIBILITY_PRIVATE: The media visibility is private

Allowed values

VISIBILITY_UNSPECIFIED

The media visibility is not specified

VISIBILITY_PUBLIC

The media visibility is public

VISIBILITY_PRIVATE

The media visibility is private

workspaceId

string

GET/v1/mediaRequires auth

#List media files

Retrieves the media files for your workspace

#Parameters

query parameters

pageSize

integer (int32)Requiredquery

The maximum number of media files to return.

pageToken

stringquery

The token for retrieving the next page of results If not provided, the first page of results will be returned

#Response

200

Everything worked as expected.

media

array<object>

nextPageToken

string

#Error response

All endpoints may return an unexpected error payload when a request cannot be processed.

error

objectRequired

Wrapped error response.

Example request (cURL)

curl -X GET "https://api.linkbreakers.com/v1/media?pageSize={pageSize}&pageToken={pageToken}" \
  -H "Authorization: Bearer YOUR_TOKEN"

Typical response

{
  "media": [
    {
      "createdAt": "2025-10-08T00:59:28.372Z",
      "fileName": "string",
      "id": "string",
      "mediaType": "TYPE_UNSPECIFIED",
      "mimeType": "string",
      "signedUrl": "string",
      "size": "string",
      "updatedAt": "2025-10-08T00:59:28.372Z",
      "uploadedBy": "string",
      "visibility": "VISIBILITY_UNSPECIFIED",
      "workspaceId": "string"
    }
  ],
  "nextPageToken": "string"
}

Base URL: https://api.linkbreakers.com

GET/v1/media/{id}Requires auth

#Get media file details

Retrieves information about a media file including its metadata and URL. Example: Getting details for media with ID "med_123".

#Parameters

path parameters

stringRequiredpath

#Response

200

Everything worked as expected.

media

object

#Error response

All endpoints may return an unexpected error payload when a request cannot be processed.

error

objectRequired

Wrapped error response.

Example request (cURL)

curl -X GET "https://api.linkbreakers.com/v1/media/{id}" \
  -H "Authorization: Bearer YOUR_TOKEN"

Typical response

{
  "media": {
    "createdAt": "2025-10-08T00:59:28.372Z",
    "fileName": "string",
    "id": "string",
    "mediaType": "TYPE_UNSPECIFIED",
    "mimeType": "string",
    "signedUrl": "string",
    "size": "string",
    "updatedAt": "2025-10-08T00:59:28.372Z",
    "uploadedBy": "string",
    "visibility": "VISIBILITY_UNSPECIFIED",
    "workspaceId": "string"
  }
}

Base URL: https://api.linkbreakers.com

POST/v1/mediaRequires auth

#Upload a media file

This endpoint allows users to upload a new media file to their Linkbreakers workspace. For now the file size limit is 3MB. Example: Uploading an image to be placed in the center of a QR Code.

#Parameters

This endpoint does not accept any parameters.

#Request body

fileData

string

The file data to upload. The file size limit is 3MB. It must be transmitted in a base64 string format when sending it through HTTP. Accepted formats are PNG and JPEG.

fileName

string

mediaType

string (enum)

- TYPE_UNSPECIFIED: The media type is not specified - TYPE_CENTRAL_QRCODE_IMAGE: The media type is a central QR code image

Allowed values

TYPE_UNSPECIFIED

The media type is not specified

TYPE_CENTRAL_QRCODE_IMAGE

The media type is a central QR code image

visibility

string (enum)

- VISIBILITY_UNSPECIFIED: The media visibility is not specified - VISIBILITY_PUBLIC: The media visibility is public - VISIBILITY_PRIVATE: The media visibility is private

Allowed values

VISIBILITY_UNSPECIFIED

The media visibility is not specified

VISIBILITY_PUBLIC

The media visibility is public

VISIBILITY_PRIVATE

The media visibility is private

#Response

200

Everything worked as expected.

media

object

#Error response

All endpoints may return an unexpected error payload when a request cannot be processed.

error

objectRequired

Wrapped error response.

Example request (cURL)

curl -X POST "https://api.linkbreakers.com/v1/media" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  --data '{"fileData":"iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAYAAAAfFcSJAAAADUlEQVR42mNkYPhfDwAChwGA60e6kgAAAABJRU5ErkJggg==","fileName":"example.jpg","mediaType":"TYPE_UNSPECIFIED","visibility":"VISIBILITY_UNSPECIFIED"}'

Sample payload (application/json)

{
  "fileData": "iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAYAAAAfFcSJAAAADUlEQVR42mNkYPhfDwAChwGA60e6kgAAAABJRU5ErkJggg==",
  "fileName": "example.jpg",
  "mediaType": "TYPE_UNSPECIFIED",
  "visibility": "VISIBILITY_UNSPECIFIED"
}

Typical response

{
  "media": {
    "createdAt": "2025-10-08T00:59:28.372Z",
    "fileName": "string",
    "id": "string",
    "mediaType": "TYPE_UNSPECIFIED",
    "mimeType": "string",
    "signedUrl": "string",
    "size": "string",
    "updatedAt": "2025-10-08T00:59:28.372Z",
    "uploadedBy": "string",
    "visibility": "VISIBILITY_UNSPECIFIED",
    "workspaceId": "string"
  }
}

Base URL: https://api.linkbreakers.com

DELETE/v1/media/{id}Requires auth

#Delete a media file

Removes a media file from the workspace. This operation cannot be undone.

#Parameters

path parameters

stringRequiredpath

#Response

200

Everything worked as expected.

No structured schema available for this section.

#Error response

All endpoints may return an unexpected error payload when a request cannot be processed.

error

objectRequired

Wrapped error response.