Get author(s) by network handle

Get one or more authors by the networkhandle passed in for the specified source channel

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Details

Returns one or more authors by the networkhandle passed in for the specified source channel.

Because handles and user names are not globally unique across a source channel, this call can return more than one unrelated author.

If more than one author is returned they will be contained in a personList, each with a unique top-level ID and handles array.

Use this for a networktype of "facebook", or "instagram" where there is a single, default instance of the network. If the networktype is "lithium" or "crm", where there can be multiple instances of the network, use: /api/v2/authors/networks/networktype/instances/networkinstance/handles/networkhandle

Related endpoints

ActionEndpoint
GET/authors/networks/{networktype}/ids/{networkid}
Get a single author by source network ID where the source network has only a single, default instance, such as Facebook or Instagram
PUT/authors/networks/{networktype}/ids/{networkid}
Update a single author by source network ID on the default instance of the source network
GET/authors/networks/{networktype}/instances/{networkinstance}/ids/{networkid}
Return one or more authors by the networkhandle passed in for the specified instance of a network.
PUT/authors/networks/{networktype}/instances/{networkinstance}/ids/{networkid}
Update a single author by network ID on a specific instance of that network
GET/authors/networks/{networktype}/instances/{networkinstance}/handles/{networkhandle}
Returns one or more authors by the networkhandle passed in for the specified instance of a network.
Path Params
string
required

The type of network that manages content created by or about an author. Supported values are: "instagram", "facebook", "googleplus", "lithium", "crm"

For a networktype of value "lithium" or "crm" you must also pass the networkinstance, because these types of networks can have multiple instances as opposed to Instagram, Facebook, or Google+ that have only a single, default network.

The Author API supports "instagram", "facebook", "googleplus", "lithium", and "crm" only as values for networktype.

string
required

The external identification for the author, such as a Community or a Instagram handle. This is different than the networkid generated by a network for internal use. Note that networkhandle is not used with Facebook in POST calls.

Query Params
boolean
Defaults to false

When true, the response includes authors whose CRM entry has been deleted. Otherwise, the response will not include authors whose CRM entry has been deleted.

Responses

Language
URL
LoadingLoading…
Response
Choose an example:
application/json