Qodex.ai

Get Information about a User

GET {{baseUrl}}/1/admin/users/:id?company_id=dolore&threads_meta=true&since_updated_usec=1541016510656993&include_deleted=true&thread_ids=UcZ9AAhvqrc,AVN9AAeqq5w&shared_thread_id=dolore&sort_by=title&sort_order=asc

Returns information about the specified user. When no optional parameters are present, the return value is a dictionary that contains information about the user. This dictionary includes a field with three sub-dictionaries, one for each of the user's threads, contacts and companies.

For larger companies, this information can become too large to return in one request. There are optional parameters that clients can use to limit or filter this information.

Request Params

KeyDatatypeRequiredDescription
company_idstring(Required) The ID of the company to use.
threads_metabooleanIf true, the response excludes information about the requested user's contacts and their companies. The information about the user's threads is limited to their last updated timestamps, permalinks, and whether they've been deleted. Refer to the threads_meta_user_info response schema for the 200 response below.
since_updated_usecnumberTimestamp in microseconds since the UNIX epoch. Limits thread results to only threads that have been last updated after this timestamp.
include_deletedbooleanIf true, response will include threads that the requested user has been removed from.
thread_idsstringComma separated list of thread IDs. Limits the returned threads to
those in this list.
shared_thread_idstringID of a thread in the admin's company. If the the requested user
is an external user and is a member of this thread, we return the
name, emails, company, and ID of the external user rather than
denying access completely. Refer to the restricted_user_info
response schema for the 200 response below.
sort_bystringDetermines which field to sort the shared_folder_ids
and group_folder_ids lists by, if they're included in the
response.
sort_orderstringDetermines what order to sort the shared_folder_ids
and group_folder_ids lists by, if they're included in the
response. asc sorts the lists in ascending order while desc
sorts the lists in descending order.

RESPONSES

status: OK

{"affinity":0.43,"id":"UTUAEAiZl6B","is_robot":false,"name":"Jane Doe","threads":{"threads":{},"users":{},"companies":{}},"company_id":"IMbAcASGu56","emails":["jane@example1.com","jane@example2.com"],"disabled":false,"created_usec":1632022665732239,"chat_thread_id":"adHAAAKik9A","profile_picture_url":"https://acme.quip.com:443/vWMeAXtnYvRMJJH_A6OaMA","desktop_folder_id":"AGWAOAhT3qk","archive_folder_id":"BGWAOAhT3qk","starred_folder_id":"CGWAOAhT3qk","private_folder_id":"DGWAOAhT3qk","trash_folder_id":"EGWAOAhT3qk","shared_folder_ids":["FGWAOAhT3qk","GGWAOAhT3qk"],"group_folder_ids":["HGWAOAhT3qk","IGWAOAhT3qk"],"error":"ut sint"}