Users

Gets a filtered list of Users

This is a read only endpoint that returns a list of users associated with an Insightly instance. Use this endpoint when you need to obtain a list of valid USER_IDs, for example, when you want to assign a task to a specific user (do not confuse the USER_ID with their CONTACT_ID). <br /> To filter with a field name and value, both field_name and field_value parameters must be provided. <br /> For other filters, only one optional parameter (excluding brief, top, skip and count_total) can be specified. <br /> Simple object graphs (excluding NOTELINKS) are returned if "brief=true" is used in the query string.

get/Users/Search

Request

  • Base URL
    https://api.insightly.com/v3.1
  • Auth
    none declared. Required headers: Authorization

Query parameters

field_namestring

Optional, standard field name of Users

field_valuestring

Optional, field value of the user

updated_after_utcstring date-time

Optional, earliest date when note was last updated.

skipinteger

Optional, number of users to skip.

topinteger

Optional, maximum number of users to return in the response.

count_totalboolean

Optional, true if total number of records should be returned in the response headers.

Headers

Authorizationstring required

Authorization

Response

Request succeeded.

USER_IDinteger
CONTACT_IDinteger
FIRST_NAMEstring
LAST_NAMEstring
TIMEZONE_IDstring
EMAIL_ADDRESSstring
EMAIL_DROPBOX_IDENTIFIERstring
EMAIL_DROPBOX_ADDRESSstring
ADMINISTRATORboolean
ACCOUNT_OWNERboolean
ACTIVEboolean
DATE_CREATED_UTCstring date-time
DATE_UPDATED_UTCstring date-time
USER_CURRENCYstring
CONTACT_DISPLAYstring
CONTACT_ORDERstring
TASK_WEEK_STARTinteger
INSTANCE_IDinteger
PROFILE_IDinteger
ROLE_IDinteger

Changes

No recorded changes to this operation across all 1 revision of this API.