API Documentation

GET /api/folder

Returns the current date, split into parts so it can be used easily by Zapier steps. Optionally, a base folder can be provided.

Query Parameters:

baseFolder (optional): The base folder to use

Headers:

X-API-KEY: API Key to use.

Example Response:

{
  "folderParts": {
    "baseFolder": "base_folder",
    "year": "2024",
    "month": "11",
    "monthName": "November",
    "day": "26",
    "weekdayName": "Tuesday",
    "quarter": "4",
    "week": "48"
  }
}

Try it out

Please sign in to test the API.

GET /api/smart-folder

Analyze the submitted document and find the date to file this document in the correct folder. Returns the folder parts for the document and optionally a base folder, if provided.

Query Parameters:

baseFolder (optional): The base folder to use

Body Parameters:

document : a URL pointing to a document to analyze

Headers:

X-API-KEY: API Key to use.

Example Response:

{
  "folderParts": {
    "baseFolder": "base_folder",
    "year": "2024",
    "month": "11",
    "monthName": "November",
    "day": "26",
    "weekdayName": "Tuesday",
    "quarter": "4",
    "week": "48"
  }
}

Try it out

Please sign in to test the API.

GET /api/key

Returns the API key, needed for Zapier integration

Note: Authentication happens with session cookie.

Example Response:

{
  "apiKey": "1234ABCD"
}

Try it out

Please sign in to test the API.

DELETE /api/key

Delete the API key. This will invalidate the current API key and break any integration that uses it.

Note: Authentication happens with session cookie.

Example Response:

{
  "message": "API key deleted"
}

Try it out

Please sign in to test the API.

GET /api/me

Returns the current logged in user and some of his details.

Headers:

X-API-KEY: API Key to use. (note that you can also authenticate with session token)

Example Response:

{
    "id":1,
    "email":"me@email.provider",
    "clerk_user_id":"1234ABCD",
    "api_key":"1234ABCD",
    "onboarding_complete":true,
    "newsletter":false
}

Try it out

Please sign in to test the API.