Confirmed users
98
edits
Raindrop/WebApis/inflow: Difference between revisions
Jump to navigation
Jump to search
add details about 'contacts' API
No edit summary |
(add details about 'contacts' API) |
||
| Line 136: | Line 136: | ||
* '''num_unread''': The total number of conversations in the group with unread messages. | * '''num_unread''': The total number of conversations in the group with unread messages. | ||
=== Contacts === | |||
The 'contacts' namespace is used to access information regarding contacts and (indirectly) identities | |||
==== by_name method ==== | |||
Inflow API entry point: '''/raindrop/_api/inflow/contacts/by_name''' | |||
Fetches and returns information about one or more contacts by the contact displayName. | |||
===== Request Params ===== | |||
* '''startname''': default=null: The first name to search, or null to start at the start | |||
* '''endname''': default=null: The last name to search, or null for no end. | |||
* '''limit''': The maximum number of items to return | |||
* '''skip''': The number of items to skop | |||
===== Response ===== | |||
The response is an array of 'contact' objects. Each object has the following properties: | |||
* '''id''': The contact ID. | |||
* '''displayName''': The contact's display name. | |||
==== with_identity method ==== | |||
Inflow API entry point: '''/raindrop/_api/inflow/contacts/with_identity''' | |||
Fetches and returns information about one or more contacts which are associated with the specified identity. | |||
===== Request Params ===== | |||
* '''id''': The identity ID for which the contact is desired. | |||
===== Response ===== | |||
The response is an array of 'contact' objects - usually only one contact will be returned, although occasionally a single identity ID (eg, email address) will be associated with multiple contacts. Each object has the following properties: | |||
* '''id''': The contact ID. | |||
* '''relationship''': The relationship between the identity and the contact. For example, if the identity ID specifies a phone number, the relationship might be "home" or "office". If it is an email address, it may be the generic "email", or possibly some other identifier. | |||
==== API response objects ==== | ==== API response objects ==== | ||