Intervals API Resource: client

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

For accessing information about clients.

Collection

Allowed HTTP Methods
MethodGroup Access
GETAdministrator, Manager, Resource, Executive
Allowed Filters
Filter NameRequired?ExpectsDefaultDescription
localid no integer1 Restricts the list based on a client's "localid," which is the number that appears associated with the client in the Intervals application.
active no boolean Limits the list to clients who are either active or inactive.
search no string Limits the list to clients who match the search string. Searches client name, description and localid.
projectsonly no boolean f Limits the list to clients who have active projects only.
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 /client/

To filter the list based on certain parameters:

GET /client/?active={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
name yes string (255) The name of the client
datecreated yes date
description no html The client description/notes area.
email no string (255) The main client email address. This email can also be part of a person contact, that is a perso profile who cannot login.
website no string (255) Client website URL.
phone no string (50) Client phone number.
fax no string (50) Client fax number.
address no string The client address.
active yes boolean t

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

Examples

To retrieve one member resource:

GET /client/{id}/

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

To delete a particular member resource:

DELETE /client/{id}/

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

To create a new member resource:

POST /client/
{
    "name": value,
    "datecreated": 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 /client/{id}/
{
    "name": value,
    "description": 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