v1Resources/Social Inbox/getRead inbox author contact

Read inbox author contact

Requires an active agency user with Social access and Social Inbox enabled. Requires an unrestricted agency owner/admin and unrestricted credential: contacts and vocabulary are shared across clients. Identify the author through kind and id of an existing inbox item. Returns contact with profile fields and listIds. An unknown saved profile returns empty fields; an item with no usable author identity returns 404. Never guesses a contact from a supplied name.

get/api/v1/inbox/contacts
inbox:read
Query parameters
kindstring (comment | message | mention)required
idstringrequired
Response
dataobjectoptional
Errors
400The request is missing a required parameter or is otherwise malformed.
401Missing, invalid, expired, or revoked API key.
403The key lacks the required scope, or isn't authorized for this client/location.
404The resource wasn't found, or doesn't belong to your agency.
409The requested change conflicts with the current record.
413More than 2000 items match or belong to expanded threads; narrow the selection.
429Too many requests. Retry after the number of seconds in the Retry-After header.
503The inbox operation could not be completed.
get/api/v1/inbox/contacts
Your API key
kind *
id *
{}

New to the Synup API?