Intervals API Resource: person

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

For accessing and updating information about people. Only administrators may create, update or delete user accounts.

Collection

Allowed HTTP Methods
MethodGroup Access
GETAdministrator, Manager, Resource
Allowed Filters
Filter NameRequired?ExpectsDefaultDescription
localid no integer1 Restricts the list based on a person's "localid," which is the number that appears associated with the person in the Intervals application.
username no string Limits the list to people whose usernames match the search string.
email no string Limits the list to people whose emails match the search string.
firstname no string Limits the list to people whose first names match the search string.
lastname no string Limits the list to people whose last names match the search string.
excludegroupids no integer1 Excludes people from the list who fall in the group IDs submitted.
projectid no integer1 Limits the list to people who have access to the project IDs submitted.
clientid no integer1 Limits the list to people who are associated with the ID of this client.
projectclientid no integer1 Limits the list to people who have access to projects that belong to the client IDs submitted.
search no string Limits the list to people who match the search string. Searches firstname, lastname, client, username, notes and contact info.
active no boolean Limits the list to people who are either active or inactive.
groupid no integer Limits the list to people who are in the group of the ID submitted.
allprojects no boolean Limits the list to people who should be added to all future projects.
restricttasks no boolean Limits the list to people who are restricted to only tasks to which they own or have been assigned.
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 /person/

To filter the list based on certain parameters:

GET /person/?projectclientid={value}

Note: You can string together multiple filters.

Member

Allowed HTTP Methods
MethodGroup Access
GETAdministrator, Manager, Resource
DELETEAdministrator
POSTAdministrator
PUTAdministrator
Settable Fields for PUT and POST Requests
Field NameRequired?ExpectsDefaultDescription
clientid no integer This ID of the client this person is associated with.
title no string (255)
firstname yes string (65)
lastname no string (85)
allprojects yes boolean f If true, this person should be automatically added to all future projects. It does not grant access to existing projects. This will have to be done manually.
notes no html
private yes boolean t Whether this person's contact information is visible to resource- and executive-level users.
active no boolean t Whether the person is active or inactive.
username no string (255) For users that can log in, the username they will log in with. To remove a person's ability to log in, set this field to blank.
password no string (30) For users that can log in, the password they will log in with.
email no string (255) REQUIRED for adding a new person who can log in. Otherwise, edit a person's contact information using the personcontact resource.
groupid no integer REQUIRED for adding a person who can log in.

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

Examples

To retrieve one member resource:

GET /person/{id}/

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

To delete a particular member resource:

DELETE /person/{id}/

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

To create a new member resource:

POST /person/
{
    "firstname": value,
    "allprojects": value,
    "private": 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 /person/{id}/
{
    "clientid": value,
    "password": 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