Intervals API Resource: project

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

Collection

Allowed HTTP Methods
MethodGroup Access
GETAdministrator, Manager, Resource, Executive
Allowed Filters
Filter NameRequired?ExpectsDefaultDescription
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.
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.
dateend no date Limits the list to projects ending on this date.
search no string Limits the list to propjects 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.
offset no integer
limit no integer 10

1 Indicates that multiple values are allowed, in CSV format (e.g. "3,5,11,19").
2 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/?localid={value}

Note: You can string together multiple filters.

Member

Allowed HTTP Methods
MethodGroup Access
GETAdministrator, Manager, Resource, Executive
DELETEAdministrator
POSTAdministrator
PUTAdministrator
Settable Fields for PUT and POST Requests
Field NameRequired?ExpectsDefaultDescription
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').
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}/
{
    "budget": value,
    "billable": value
}

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

 

Don’t have an Intervals account? Start your own unlimited trial.

No credit card required. No software to install. Cancel any time.

Try it Free