Intervals API Resource:

personcontact

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

For accessing and updating contact information about people. This includes phone numbers, email addresses, physical addresses, websites, etc.

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

{
    "id": "123456",
    "personid": "123456",
    "contact_type_id": "123456",
    "contact_descriptor_id": "123456",
    "value": "string value",
    "contact_type": "Phone",
    "contact_descriptor": "Work"
}

When retrieving a collection (GET /personcontact/), the response envelope includes: personid (authenticated user's ID), status ("OK"), code (200), listcount (total matching records before limit/offset), and personcontact (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:

{
    "personid": value,
    "value": value,
    "contacttypeid": value,
    "contactdescriptorid": 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:

{
    "value": value,
    "contactdescriptorid": value
}

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