Documents

Retrieve all documents across the companies the current apikey has access to from Basecone.

GET documents

Retrieve all documents for a specific company from Basecone.

GET documents?companyId=:id

Sorting

Sorting can be performed by using the sort parameter, for the following properties:

Property
CreatedOn
ModifiedOn

Document collection properties

Property Type Description
Documents Array A list of documents.
_links Array A list of useful preconfigured uri's a client app can use to navigate this resource collection.
_metadata Complex object Optional object with additional information concerning the current returned result.

For details on document properties see document details.

For details on collections see collection details.

Example response:

{
    "documents": [
        {
            "documentId": "20124957-a908-4552-8f4f-9e849199d1df",
            "name": "2Jours",
            "source": "WebService"
        },
        {
            "documentId": "46b41148-73af-415e-bb66-ea78a48d2c5a",
            "name": "2Jours",
            "source": "WebService"
        },
        {
            "documentId": "f15830dc-0f06-4e15-803a-9e3a3d88d655",
            "name": "2Jours - Copy (7)",
            "source": "WebService"
        },
        {
            "documentId": "d738c413-183d-4604-8334-5bc6f3267a77",
            "name": "2Jours - Copy (8)",
            "source": "WebService"
        },
        {
            "documentId": "892f9a3c-58ab-4da6-af1e-e3407ec65181",
            "name": "2Jours - Copy (7)",
            "source": "WebService"
        }
    ],
    "_links": [
        {
            "rel": "self",
            "href": "http://api.basecone.com/documents"
        }
    ],
    "_metadata": {
        "total": 1162,
        "count": 5
    }
}