API-Referenz | Workspace files

Methode	Pfad	Zusammenfassung
GET	…/files	List files attached to the workspace
GET	…/files/search	Search workspace files by attributes
POST	…/files/move	Move a workspace file to a different folder or location
GET	…/files/{fileId}/download	Generate a time-limited download URL for a workspace file

Die Pfade beginnen mit /workspaces/{workspaceId}. GET-Endpunkte brauchen workspace-files:read, die übrigen workspace-files:write.

Das Objekt WorkspaceFile

firestoreIdstringerforderlich

creationobjecterforderlich

When and by whom the resource was created.

2 untergeordnete Felder anzeigen

creationDateTimestringdate-timeerforderlich

Date and time when the resource was created.

createdBystring

ID of the user who created the resource, when recorded.

workspaceIdstringerforderlich

ID of the workspace.

sizeintegererforderlich

mimeTypestringerforderlich

filenamestringerforderlich

gcsPathstringerforderlich

Alle 14 Felder anzeigen

extensionstringerforderlich

checksumMd5string

checksumCrc32cstring

customMetadataRecord<string, string | boolean | number | null>erforderlich

scopestringerforderlich

Werteworkspace_attachmentbank_account_attachmentbank_transaction_attachmentbank_transaction_importbank_transaction_exportdraft_payment_attachmentinitiated_payment_attachmentinvoice_attachment

targetDocumentPathstring

targetDocumentIdstring

Das Objekt WorkspaceFile

{
  "firestoreId": "string",
  "creation": {
    "creationDateTime": "2026-03-02T09:15:00.000Z",
    "createdBy": "Xq3vT9mB2kLpR7sN4wYc8dZf1aHj"
  },
  "workspaceId": "Wk7fQ2xR9bLm4tZp8sNv",
  "size": 0,
  "mimeType": "string",
  "filename": "string",
  "gcsPath": "string",
  "extension": "string",
  "checksumMd5": "string",
  "checksumCrc32c": "string",
  "customMetadata": {
    "key": "string"
  },
  "scope": "workspace_attachment",
  "targetDocumentPath": "string",
  "targetDocumentId": "Hk2xNq8vR4tYw6ZbPj3c"
}

GET/workspaces/{workspaceId}/files

List files attached to the workspace

Bereichworkspace-files:read

Pfadparameter

workspaceIdstringerforderlich

ID of the workspace.

Abfrageparameter

limitinteger

Maximum number of items to return, from 1 to 100. A missing, invalid or non-positive value falls back to 20, and a larger value to 100.

Standard20

startAfterstring

Cursor of the page to return: the nextCursor of the previous page.

fieldsstring

Comma-separated property paths to include in the response, or in each item of a list. Use dots for nested paths.

idsstring[]

Comma-separated IDs of the items to return, up to 30. When set, limit, startAfter and the filters are ignored.

Rückgabe

200

List of items

dataWorkspaceFile[]erforderlich

Items of the page, in list order.

limitintegererforderlich

Page size of the request, or the number of requested ids.

nextCursorstring

Cursor of the next page, to pass as startAfter. Absent when the page holds fewer items than limit; a full last page still has one, and the page it points to is empty.

curl 'https://api.business.swayapp.io/v1/workspaces/Wk7fQ2xR9bLm4tZp8sNv/files' \
  -H "Authorization: Bearer $SWAY_API_KEY"

const response = await fetch('https://api.business.swayapp.io/v1/workspaces/Wk7fQ2xR9bLm4tZp8sNv/files', {
  headers: {
    Authorization: `Bearer ${process.env.SWAY_API_KEY}`,
  },
});
console.log(await response.json());

import os

import requests

response = requests.get(
    "https://api.business.swayapp.io/v1/workspaces/Wk7fQ2xR9bLm4tZp8sNv/files",
    headers={"Authorization": f"Bearer {os.environ['SWAY_API_KEY']}"},
)
print(response.json())

{
  "data": [
    {
      "firestoreId": "string",
      "creation": {
        "creationDateTime": "2026-03-02T09:15:00.000Z",
        "createdBy": "Xq3vT9mB2kLpR7sN4wYc8dZf1aHj"
      },
      "workspaceId": "Wk7fQ2xR9bLm4tZp8sNv",
      "size": 0,
      "mimeType": "string",
      "filename": "string",
      "gcsPath": "string",
      "extension": "string",
      "checksumMd5": "string",
      "checksumCrc32c": "string",
      "customMetadata": {
        "key": "string"
      },
      "scope": "workspace_attachment",
      "targetDocumentPath": "string",
      "targetDocumentId": "Hk2xNq8vR4tYw6ZbPj3c"
    }
  ],
  "limit": 0,
  "nextCursor": "string"
}

{
  "error": {
    "code": "invalid-argument",
    "message": "Invalid request"
  }
}

{
  "error": {
    "code": "unauthenticated",
    "message": "Invalid or expired credentials"
  }
}

{
  "error": {
    "code": "permission-denied",
    "message": "Missing required scope: invoices:read"
  }
}

{
  "error": {
    "code": "not-found",
    "message": "Resource not found"
  }
}

{
  "error": {
    "code": "internal",
    "message": "An internal error occurred"
  }
}

GET/workspaces/{workspaceId}/files/search

Search workspace files by attributes

Bereichworkspace-files:read

Pfadparameter

workspaceIdstringerforderlich

ID of the workspace.

Abfrageparameter

fieldsstring

Comma-separated property paths to include in the response, or in each item of a list. Use dots for nested paths.

querystringerforderlich

pageinteger

Standard0

sizeinteger

Standard20

Rückgabe

200

Successful response

dataWorkspaceFile[]erforderlich

curl 'https://api.business.swayapp.io/v1/workspaces/Wk7fQ2xR9bLm4tZp8sNv/files/search?query=string' \
  -H "Authorization: Bearer $SWAY_API_KEY"

const response = await fetch('https://api.business.swayapp.io/v1/workspaces/Wk7fQ2xR9bLm4tZp8sNv/files/search?query=string', {
  headers: {
    Authorization: `Bearer ${process.env.SWAY_API_KEY}`,
  },
});
console.log(await response.json());

import os

import requests

response = requests.get(
    "https://api.business.swayapp.io/v1/workspaces/Wk7fQ2xR9bLm4tZp8sNv/files/search?query=string",
    headers={"Authorization": f"Bearer {os.environ['SWAY_API_KEY']}"},
)
print(response.json())

{
  "data": [
    {
      "firestoreId": "string",
      "creation": {
        "creationDateTime": "2026-03-02T09:15:00.000Z",
        "createdBy": "Xq3vT9mB2kLpR7sN4wYc8dZf1aHj"
      },
      "workspaceId": "Wk7fQ2xR9bLm4tZp8sNv",
      "size": 0,
      "mimeType": "string",
      "filename": "string",
      "gcsPath": "string",
      "extension": "string",
      "checksumMd5": "string",
      "checksumCrc32c": "string",
      "customMetadata": {
        "key": "string"
      },
      "scope": "workspace_attachment",
      "targetDocumentPath": "string",
      "targetDocumentId": "Hk2xNq8vR4tYw6ZbPj3c"
    }
  ]
}

{
  "error": {
    "code": "invalid-argument",
    "message": "Invalid request"
  }
}

{
  "error": {
    "code": "unauthenticated",
    "message": "Invalid or expired credentials"
  }
}

{
  "error": {
    "code": "permission-denied",
    "message": "Missing required scope: invoices:read"
  }
}

{
  "error": {
    "code": "not-found",
    "message": "Resource not found"
  }
}

{
  "error": {
    "code": "internal",
    "message": "An internal error occurred"
  }
}

POST/workspaces/{workspaceId}/files/move

Move a workspace file to a different folder or location

Bereichworkspace-files:write

Pfadparameter

workspaceIdstringerforderlich

ID of the workspace.

Request-Body

oldPathstringerforderlich

newPathstringerforderlich

Rückgabe

204

No content

curl -X POST 'https://api.business.swayapp.io/v1/workspaces/Wk7fQ2xR9bLm4tZp8sNv/files/move' \
  -H "Authorization: Bearer $SWAY_API_KEY" \
  -H 'Content-Type: application/json' \
  -d '{
  "oldPath": "string",
  "newPath": "string"
}'

const response = await fetch('https://api.business.swayapp.io/v1/workspaces/Wk7fQ2xR9bLm4tZp8sNv/files/move', {
  method: 'POST',
  headers: {
    Authorization: `Bearer ${process.env.SWAY_API_KEY}`,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    "oldPath": "string",
    "newPath": "string"
  }),
});
console.log(response.status);

import os

import requests

response = requests.post(
    "https://api.business.swayapp.io/v1/workspaces/Wk7fQ2xR9bLm4tZp8sNv/files/move",
    headers={"Authorization": f"Bearer {os.environ['SWAY_API_KEY']}"},
    json={
        "oldPath": "string",
        "newPath": "string",
    },
)
print(response.status_code)

{
  "error": {
    "code": "invalid-argument",
    "message": "Invalid request"
  }
}

{
  "error": {
    "code": "unauthenticated",
    "message": "Invalid or expired credentials"
  }
}

{
  "error": {
    "code": "permission-denied",
    "message": "Missing required scope: invoices:read"
  }
}

{
  "error": {
    "code": "not-found",
    "message": "Resource not found"
  }
}

{
  "error": {
    "code": "internal",
    "message": "An internal error occurred"
  }
}

GET/workspaces/{workspaceId}/files/{fileId}/download

Generate a time-limited download URL for a workspace file

Bereichworkspace-files:read

Pfadparameter

workspaceIdstringerforderlich

ID of the workspace.

fileIdstringerforderlich

ID of the workspace file.

Abfrageparameter

fieldsstring

Comma-separated property paths to include in the response, or in each item of a list. Use dots for nested paths.

Rückgabe

200

Successful response

dataFileDownloadUrlerforderlich

2 untergeordnete Felder anzeigen

downloadUrlstringerforderlich

Time-limited URL to download the file.

expiresAtstringerforderlich

Instant after which downloadUrl stops working.

curl 'https://api.business.swayapp.io/v1/workspaces/Wk7fQ2xR9bLm4tZp8sNv/files/Fl1qS6hV3nTx8mPc5wZr/download' \
  -H "Authorization: Bearer $SWAY_API_KEY"

const response = await fetch('https://api.business.swayapp.io/v1/workspaces/Wk7fQ2xR9bLm4tZp8sNv/files/Fl1qS6hV3nTx8mPc5wZr/download', {
  headers: {
    Authorization: `Bearer ${process.env.SWAY_API_KEY}`,
  },
});
console.log(await response.json());

import os

import requests

response = requests.get(
    "https://api.business.swayapp.io/v1/workspaces/Wk7fQ2xR9bLm4tZp8sNv/files/Fl1qS6hV3nTx8mPc5wZr/download",
    headers={"Authorization": f"Bearer {os.environ['SWAY_API_KEY']}"},
)
print(response.json())

{
  "data": {
    "downloadUrl": "string",
    "expiresAt": "2026-03-02T09:30:00.000Z"
  }
}

{
  "error": {
    "code": "invalid-argument",
    "message": "Invalid request"
  }
}

{
  "error": {
    "code": "unauthenticated",
    "message": "Invalid or expired credentials"
  }
}

{
  "error": {
    "code": "permission-denied",
    "message": "Missing required scope: invoices:read"
  }
}

{
  "error": {
    "code": "not-found",
    "message": "Resource not found"
  }
}

{
  "error": {
    "code": "internal",
    "message": "An internal error occurred"
  }
}

Cookies, mit Ihrer Einwilligung

Workspace files

Das Objekt WorkspaceFile

List files attached to the workspace

Pfadparameter

Abfrageparameter

Rückgabe

Search workspace files by attributes

Pfadparameter

Abfrageparameter

Rückgabe

Move a workspace file to a different folder or location

Pfadparameter

Request-Body

Rückgabe

Generate a time-limited download URL for a workspace file

Pfadparameter

Abfrageparameter

Rückgabe

Bauen Sie auf Ihren eigenen Daten.