Customer Documents API Documentation

Overview

This sub-collection contains documents pertinent to a particular customer account.

Fields

Name Type Description
id integer The unique identifier of the document. This is placed in the URL when making API calls for the document.
url string The unique API URL of the document.
name string The name of the document.
pdf string (URL) A link to the document, in PDF form.
expiration_date string (ISO-8601 date) The day that the document expires (or expired), or null if it does not expire.
is_expired boolean Whether the document has expired.
created_at string (ISO-8601 datetime) When the document was added to the Capitan database.
updated_at string (ISO-8601 datetime) When the document's record in the Capitan database was last updated.

Operations

List

Request
GET /api/customers/35/documents/

Response
200 OK
{
    "count": 2,
    "next": null,
    "previous": null,
    "results": [
        {
            "id": 421,
            "url": "https://api.hellocapitan.com/api/customers/35/documents/421/",
            "name": "Waiver",
            ...
        },
        ...
    ]
}

Read

Request
GET /api/customers/35/documents/421/

Response
200 OK
{
    "id": 35,
    "url": "https://api.hellocapitan.com/api/customers/35/documents/421/",
    "name": "Waiver",
    ...
}