Intervals API Resource:

client

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

For accessing information about clients.

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 retrieve the entire list of this resource:

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

{
    "id": "123456",
    "name": "Example Name",
    "datecreated": "2026-01-15",
    "description": "<p>Example text</p>",
    "email": "user@example.com",
    "website": "https://example.com",
    "phone": "555-0100",
    "fax": "string value",
    "address": "123 Main St",
    "active": "t",
    "localidunpadded": "1",
    "localid": "123456"
}

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

Examples

To retrieve one member resource:

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

To delete a particular member resource:

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

To create a new member resource:

{
    "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:

{
    "phone": value,
    "address": value
}

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