Intervals API Resource:

projectteam

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

This resource is used to retrieve a list of people assigned to a project, or to add or remove people on a project. This resource applies only to non administrator users: Manager, Resource, and Executive.

Collection

¹ 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 filter the list based on certain parameters:

Note: You can string together multiple filters.

Member

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

Response Fields

{
    "projectid": "123456",
    "personid": [
        "425827",
        "428829",
        "427865"
    ]
}

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

Examples

To remove one person from a project, you may send an object keyed by personid, and its value corresponding to a personid of: Manager, Resource, and Executive user level. Sending an administrator level user will have no effect on their ability to view a project.

{
    "personid": "123"
}

To remove more than one person: send an array of objects:

[
    {"personid": "123"},
    {"personid": "456"},
]

To add one person with access to viewing secure project notes:

{
    "personid": "123", "securenotes": "t"
}

To add more than one person send an array of objects:

[
    {"personid": "123", "securenotes": "t"},
    {"personid": "456", "securenotes": "f"}
]

securenotes determines whether user has access to viewing secure project notes and does not apply to the executive user level.