Intervals API Resource: project

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

Collection

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

Allowed Filters
Filter Name	Required?	Expects	Default	Description
localid	no	integer1		Restricts the list based on a project's "localid," which is the number that appears associated with the project in the Intervals application.
clientid	no	integer1		Limits the list to projects belonging to the client whose ID was passed. Passing a value of -1 returns projects that do not belong to any client.
managerid	no	integer1		Limits the list to projects managed by the person whose ID was passed. Passing a value of -1 returns projects that do not have any manager.
labelid	no	integer1		Limits the list to projects having this label.
name	no	string		Limits the list to projects with name matching the search string.
datestart	no	date		Limits the list to projects beginning on this date.
datestartbegin	no	date		Limits the list to projects starting on or after the date passed.
datestartend	no	date		Limits the list to projects starting on or before the date passed.
dateend	no	date		Limits the list to projects ending on this date.
dateendbegin	no	date		Limits the list to projects ending on or after the date passed.
dateendend	no	date		Limits the list to projects ending on or before the date passed.
search	no	string		Limits the list to projects that match the search string. Searches name, description and client and localid.
active	no	boolean		Limits the list to active or inactive projects only.
billable	no	boolean		Limits the list to billable or unbillable projects only.
personid	no	integer		Limits the list to only projects to which the person ID has access.
sortfield	no	string		Sort the list by any of the following fields: id, localid, clientid, managerid, name, datestart, dateend, billable, labelid, label (sorted by labels alphabeticaly), and label_order (sorted by label order in Settings & Defaults).
sortdir	no	string		Sets the sort direction of the returned list. Must be either "ASC" or "DESC".
offset	no	integer		Return projects starting from the nth project.
limit	no	integer	10	Sets a limit to the amount of projects 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 /project/

To filter the list based on certain parameters:

GET /project/?offset={value}

Note: You can string together multiple filters.

Member

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

Settable Fields for PUT and POST Requests
Field Name	Required?	Expects	Default	Description
clientid	no	integer		The ID of the client this project belongs to.
managerid	no	integer		The ID of the person who is manager of this project. Only administrator and manager user levels can be project managers. You can submit multiple managers in the form of comma separated integers (e.g. '22,334,222').
labelid	no	integer		The ID of the label for this project.
name	yes	string (255)		The name of this project.
description	no	html		A short description of the project.
datestart	yes	date		The start date of the project.
dateend	no	date		The end date of the project.
budget	no	double		The project budget.
billable	yes	boolean	t	Whether this project is billable or unbillable. This value becomes the default value for time submitted for this project.
active	yes	boolean	t	Whether the project is active or not. Certain plans have a limited number of active accounts available.
alert_percent	no	double		Setting this value will send an alert to the project manager when a certain percentage of the budget is reached.

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

Examples

To retrieve one member resource:

GET /project/{id}/

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

To delete a particular member resource:

DELETE /project/{id}/

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

To create a new member resource:

POST /project/

{
    "name": value,
    "datestart": value,
    "billable": value,
    "active": 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 /project/{id}/

{
    "name": value,
    "budget": value
}

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