Intervals API Resource:

contactdescriptor

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

A list for describing various IDs for contact descriptor, needed for getting information about personal contacts.

Collection

Allowed HTTP Methods
Method	Group Access
GET	Administrator, Manager, Resource, Executive

Allowed Filters
Filter Name	Required?	Expects	Default	Description
contacttypeid	yes	integer		Each contact type has various descriptors. This limits the list by the contact type of the ID passed.

¹ 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:

GET /contactdescriptor/?contacttypeid={value}

Note: You can string together multiple filters.

Response Fields

These fields describe the response payload from GET /contactdescriptor/ for this collection-only resource (see the example below and the field descriptions for how values nest in JSON). Boolean values are "t" / "f" strings. Numeric IDs and floats are returned as strings. Nullable fields may be JSON null.

Response Fields
Field Name	Nullable	Description
id	no	Unique identifier for the contact descriptor
contact_type_id	no	ID of the parent contact type this descriptor belongs to
name	no	Descriptor label (e.g. Other, Work, Mobile)
contact_type	no	Parent contact type key or name (e.g. email, phone)
rank	no	Display sort order within the contact type (lower appears first; often returned as a string in JSON)

Sample response object. Non-null values are strings in JSON (including IDs, numeric fields, and booleans as "t" / "f"). Nullable fields may be JSON null when absent.

{
    "id": "123456",
    "contact_type_id": "123456",
    "name": "Example Name",
    "contact_type": "Phone",
    "rank": "1"
}

Documentation

Resources

API Support

Looking for help?
Contact our support team.

OpenAPI

OpenAPI JSON spec (public)

Swagger UI on SwaggerHub

Start tracking time today

Connect Intervals to the tools and workflows your team already uses.

Try Intervals free