Home > Documentation

Journals

Table of contents

This endpoint lets you manage the journals in your account.

Journals help you document and track various aspects of your life. Each journal is based on a template to provide structure for each entry.

Upon account creation, a journal is created for you. You can then create new journals or delete the existing one.

The Journal object

This object represents a journal in your account.

Attributes

id integer

The ID of the journal.

object string

The object type. Always 'journal'.

name string

The name of the journal.

slug string

The URL-friendly version of the name.

journal_template_id integer|null

The ID of the template this journal is based on, if any.

created_at integer

The date and time the object was created, in Unix timestamp format.

updated_at integer

The date and time the object was last updated, in Unix timestamp format.

Example
{
"id": 1 ,
"object": "journal" ,
"name": "My Travel Journal" ,
"slug": "1-my-travel-journal" ,
"journal_template_id": null ,
"created_at": 1715145600 ,
"updated_at": 1715145600
}

Get the list of journals

This endpoint gets the list of journals in your account.

URL parameters

No URL parameters are required for this endpoint.

Query parameters

No query parameters are available for this endpoint.

Response attributes

data array

An array of journal objects.

GET /api/journals
{
"data": [
{
"id": 1 ,
"object": "journal" ,
"name": "My Travel Journal" ,
"slug": "1-my-travel-journal" ,
"journal_template_id": null ,
"created_at": 1715145600 ,
"updated_at": 1715145600
}
]
}

Get a specific journal

This endpoint retrieves a specific journal by its ID.

URL parameters

id integer required

The ID of the journal to retrieve.

Query parameters

No query parameters are available for this endpoint.

Response attributes

data object

The requested journal object.

GET /api/journals/{id}
{
"data": {
"id": 1 ,
"object": "journal" ,
"name": "My Travel Journal" ,
"slug": "1-my-travel-journal" ,
"journal_template_id": null ,
"created_at": 1715145600 ,
"updated_at": 1715145600
}
}

Create a new journal

This endpoint creates a new journal. It will return the journal in the response.

URL parameters

No URL parameters are required for this endpoint.

Query parameters

name string required

The name of the journal. Maximum 255 characters.

journal_template_id integer

The ID of the template to base this journal on.

Response attributes

data object

The created journal object.

POST /api/journals
{
"data": {
"id": 1 ,
"object": "journal" ,
"name": "My Travel Journal" ,
"slug": "1-my-travel-journal" ,
"journal_template_id": null ,
"created_at": 1715145600 ,
"updated_at": 1715145600
}
}

Update a journal

This endpoint updates a journal. It will return the journal in the response.

URL parameters

id integer required

The ID of the journal to update.

Query parameters

name string required

The name of the journal. Maximum 255 characters.

journal_template_id integer

The ID of the template to base this journal on.

Response attributes

data object

The updated journal object.

PUT /api/journals/{id}
{
"data": {
"id": 1 ,
"object": "journal" ,
"name": "My Travel Journal" ,
"slug": "1-my-travel-journal" ,
"journal_template_id": null ,
"created_at": 1715145600 ,
"updated_at": 1715145600
}
}

Delete a journal

This endpoint deletes a journal. It will return a 204 No Content response.

URL parameters

id integer required

The ID of the journal to delete.

Query parameters

No query parameters are available for this endpoint.

Response attributes

This endpoint returns a 204 No Content response with no body.

DELETE /api/journals/{id}
204 No Content
Taylor Swift being happy

Please login to vote.

It's free and will help us improve the page.

Taylor will be proud of you.

Last updated on April 5, 2025.

Edit this page on Github