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
Allowed HTTP Methods | |
---|---|
Method | Group Access |
GET | Administrator, Manager, Resource, Executive |
Allowed Filters | ||||
---|---|---|---|---|
Filter Name | Required? | Expects | Default | Description |
projectid | yes | integer | Limits the list to people belonging to this project. |
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 filter the list based on certain parameters:
GET /projectteam/?projectid={value}
Note: You can string together multiple filters.
Member
Allowed HTTP Methods | |
---|---|
Method | Group Access |
DELETE | Administrator |
POST | Administrator |
PUT | Administrator |
GET | Administrator |
Settable Fields for PUT and POST Requests | ||||
---|---|---|---|---|
Field Name | Required? | Expects | Default | Description |
projectid | yes | integer | Limits the list to people belonging to this project. |
string (xxx) indicates a string with a maximum length of xxx characters.
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.
DELETE /projectteam/{projectid}/
{ "personid": "123" }
To remove more than one person: send an array of objects:
DELETE /projectteam/{projectid}/
[ {"personid": "123"}, {"personid": "456"}, ]
To add one person with access to viewing secure project notes:
POST /projectteam/{projectid}/
{ "personid": "123", "securenotes": "t" }
To add more than one person send an array of objects:
POST /projectteam/{projectid}/
[ {"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.
Intervals API
This documentation is meant to serve as an introduction to getting started with the API.
Documentation
Resources
- client
- contactdescriptor
- contacttype
- document
- expense
- group
- invoice
- invoiceitem
- invoicenote
- invoiceterm
- me
- milestone
- milestonenote
- module
- payment
- paymenttype
- person
- personcontact
- project
- projectlabel
- projectmodule
- projectnote
- projectteam
- projectworktype
- quota
- request
- task
- tasklistfilter
- tasknote
- taskpriority
- taskstatus
- time
- timer
- worktype
API Support
Looking for help?
» Contact our support team.