List workspace documents

Coming soon: Versioned, annotated, edited and signed documents coming in Q4 2022. Until then the documents presented via Workspace Documents API are all original documents.

Path Parameters

• id cuid required

  Workspace ID

Responses

• 200
• default

---

OK

application/json

• Schema
• Example (from schema)

---

Schema

• total integer
• data object[]

  name string

  mimetype string

  size integer

  isSystemFile string

  downloadUrl string

  category string

  Logical categorisation of the associated document

{
  "total": 0,
  "data": [
    {
      "name": "string",
      "mimetype": "string",
      "size": 0,
      "isSystemFile": "string",
      "downloadUrl": "string",
      "category": "Shipping manifest"
    }
  ]
}

Unexpected error

application/json

• Schema
• Example (from schema)

---

Schema

• code string
• message string

{
  "code": "string",
  "message": "string"
}

Loading...