Référence de l’API | Workspace files

Méthode	Chemin	Résumé
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

Les chemins commencent par /workspaces/{workspaceId}. Les endpoints GET demandent workspace-files:read, les autres workspace-files:write.

L’objet WorkspaceFile

firestoreIdstringobligatoire

creationobjectobligatoire

When and by whom the resource was created.

Afficher les 2 champs enfants

creationDateTimestringdate-timeobligatoire

Date and time when the resource was created.

createdBystring

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

workspaceIdstringobligatoire

ID of the workspace.

sizeintegerobligatoire

mimeTypestringobligatoire

filenamestringobligatoire

gcsPathstringobligatoire

Afficher les 14 champs

extensionstringobligatoire

checksumMd5string

checksumCrc32cstring

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

scopestringobligatoire

Valeursworkspace_attachmentbank_account_attachmentbank_transaction_attachmentbank_transaction_importbank_transaction_exportdraft_payment_attachmentinitiated_payment_attachmentinvoice_attachment

targetDocumentPathstring

targetDocumentIdstring

L’objet 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

Portéeworkspace-files:read

Paramètres de chemin

workspaceIdstringobligatoire

ID of the workspace.

Paramètres de requête

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.

Par défaut20

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.

Renvoie

200

List of items

dataWorkspaceFile[]obligatoire

Items of the page, in list order.

limitintegerobligatoire

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

Portéeworkspace-files:read

Paramètres de chemin

workspaceIdstringobligatoire

ID of the workspace.

Paramètres de requête

fieldsstring

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

querystringobligatoire

pageinteger

Par défaut0

sizeinteger

Par défaut20

Renvoie

200

Successful response

dataWorkspaceFile[]obligatoire

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

Portéeworkspace-files:write

Paramètres de chemin

workspaceIdstringobligatoire

ID of the workspace.

Corps de la requête

oldPathstringobligatoire

newPathstringobligatoire

Renvoie

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

Portéeworkspace-files:read

Paramètres de chemin

workspaceIdstringobligatoire

ID of the workspace.

fileIdstringobligatoire

ID of the workspace file.

Paramètres de requête

fieldsstring

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

Renvoie

200

Successful response

dataFileDownloadUrlobligatoire

Afficher les 2 champs enfants

downloadUrlstringobligatoire

Time-limited URL to download the file.

expiresAtstringobligatoire

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"
  }
}

Des cookies, avec votre accord

Workspace files

L’objet WorkspaceFile

List files attached to the workspace

Paramètres de chemin

Paramètres de requête

Renvoie

Search workspace files by attributes

Paramètres de chemin

Paramètres de requête

Renvoie

Move a workspace file to a different folder or location

Paramètres de chemin

Corps de la requête

Renvoie

Generate a time-limited download URL for a workspace file

Paramètres de chemin

Paramètres de requête

Renvoie

Construisez sur vos propres données.