Intervals API Resource:

projectnote

The base URL for this resource is located at
https://api.myintervals.com/projectnote/

Collection

Allowed HTTP Methods
Method	Group Access
GET	Administrator, Manager, Resource

Allowed Filters
Filter Name	Required?	Expects	Default	Description
localid	no	integer¹		Restricts the list based on a project note's "localid," which is the number that appears associated with the note in the Intervals application.
clientid	no	integer¹		Restricts the list to project notes belonging to projects for the clients corresponding to the ID(s) passed.
projectid	no	integer¹		Restricts the list to project notes belonging to projects corresponding to the ID(s) passed.
authorid	no	integer¹		Restricts the list to project notes created by the person corresponding to the ID(s) passed.
title	no	string
search	no	string		Limits the list to project notes that match the search string. Searches title and note* (* only searched when project note is not secure).
noteid	no	integer
offset	no	integer		Return projectnotes starting from the nth projectnote.
limit	no	integer	10	Sets a limit to the amount of projectnotes returned in the response.

¹ Indicates that multiple values are allowed, in CSV format (e.g. "3,5,11,19").
² This field accepts HTML, but certain HTML elements may be stripped out.

Examples

To retrieve the entire list of this resource:

GET /projectnote/

To filter the list based on certain parameters:

GET /projectnote/?noteid={value}

Note: You can string together multiple filters.

Member

Allowed HTTP Methods
Method	Group Access
GET	Administrator, Manager, Resource
DELETE	Administrator, Manager, Resource
POST	Administrator, Manager, Resource
PUT	Administrator, Manager, Resource

Settable Fields for PUT and POST Requests
Field Name	Required?	Expects	Default	Description
projectid	yes	integer		The project this note belongs to. You can only add new notes to active projects.
title	yes	string (255)		The title of the project note.
note	yes	html		The body of the project note.
secure	yes	boolean	f	Secure project notes are securely encoded before storage; they are also only visible to people with access to secure notes for this project.

string (xxx) indicates a string with a maximum length of xxx characters.

Response Fields

The fields below are returned in GET responses. Boolean values are "t" / "f" strings. Numeric IDs and floats are returned as strings. Nullable fields may be JSON null.

Response Fields
Field Name	Nullable	Description
id	no	Unique identifier for the project note
projectid	no	ID of the parent project
authorid	no	ID of the person who created the note
title	no	Note title
note	yes	Note body (may contain HTML)
date	no	When the note was created (UTC YYYY-MM-DD HH:MM:SS)
secure	no	Whether this is a secure project note ("t"/"f") — visibility follows project secure-note rules
localid	no	Note local ID / sequence within the project (often a string in JSON)
projectactive	no	Whether the parent project is active ("t"/"f")
author	no	Full name of the note author
projectlocalid	no	Parent project’s local ID
clientlocalid	yes	Client local ID when the project has a client (empty otherwise)
mod_authorlocalid	yes	Local ID of the last modifier, if different from author (often empty)
projectlabel	yes	Project label name when set (empty when the project has no label)
projectlabelcolor	yes	Project label color (e.g. hex; empty when no label)
projectlabelactive	yes	Whether the project label is active ("t"/"f") when a label is set; empty when no label

Sample response object. Non-null values are strings in JSON (including IDs, numeric fields, and booleans as "t" / "f"). Nullable fields may be JSON null when absent.

{
    "id": "123456",
    "projectid": "123456",
    "authorid": "123456",
    "title": "Example Title",
    "note": "<p>Example text</p>",
    "date": "2026-01-15 14:30:00",
    "secure": "t",
    "localid": "123456",
    "projectactive": "t",
    "author": "First Last",
    "projectlocalid": "5",
    "clientlocalid": null,
    "mod_authorlocalid": null,
    "projectlabel": "Label A",
    "projectlabelcolor": "string value",
    "projectlabelactive": "string value"
}

When retrieving a collection (GET /projectnote/), the response envelope includes: personid (authenticated user's ID), status ("OK"), code (200), listcount (total matching records before limit/offset), and projectnote (array of result objects). Defaults, no cap on limit, and how to paginate using listcount are described in the API Introduction (Pagination).

Examples

To retrieve one member resource:

GET /projectnote/{id}/

Assuming no errors, the server will respond with 200 OK and the object requested.

To delete a particular member resource:

DELETE /projectnote/{id}/

Assuming no errors, the server will respond with 200 OK.

To create a new member resource:

POST /projectnote/

{
    "projectid": value,
    "title": value,
    "note": value,
    "secure": value
}

Assuming no errors, the server will respond with 201 Created and the newly-created element. This will allow you to get the id of the item you just created and verify the field values. Note: Only required fields were listed here. The entire list of possible fields is above.

To update a member resource:

PUT /projectnote/{id}/

{
    "projectid": value,
    "title": value
}

Assuming no errors, the server will respond with 202 Accepted and the entire element. This will allow you to verify the field values.

Documentation

Resources

API Support

Looking for help?
Contact our support team.

OpenAPI

OpenAPI JSON spec (public)

Swagger UI on SwaggerHub

Start tracking time today

Join 5,000+ companies spending their time wisely with Intervals.

Try Intervals free