The Networks API from Lithium — 16 operation(s) for networks.
openapi: 3.1.0
info:
title: agent-states-api-v2 AccountSet Networks API
version: '1.1'
servers:
- url: https://{instance}.response.lithium.com/api/v2/agentstate
variables:
instance:
default: instance
security:
- {}
tags:
- name: Networks
paths:
/networks/{networktype}/ids/{networkid}:
get:
summary: Get author by source network ID
description: Get a single author by source network ID where the source network has only a single, default instance, such as Facebook or Instagram
operationId: authorsnetworksnetworktypeidsnetworkid
parameters:
- name: networktype
in: path
description: 'The type of network that manages content created by or about an author. Supported values are: "instagram", "facebook", "googleplus", "lithium", "crm"<br><br>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, Facebook, Instagram or Google+ that have only a single, default network.<br><br>The Author API supports "instagram", "facebook", "lithium", and "crm" only as values for networktype.'
schema:
type: string
required: true
- name: networkid
in: path
description: The internal ID of the author generated by the network. For Facebook, this is the PSID. Compare this to the the externally used networkhandle. The network ID must be unique to a given networkinstance.
schema:
type: string
required: true
- name: include_deleted_crm
in: query
description: 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.
schema:
type: boolean
default: false
responses:
'200':
description: '200'
content:
application/json:
examples:
Result:
value: "{\n \"status\": \"success\",\n \"data\": [\n {\n \"id\": \"1af519d7-7638-4f50-9276-a020f845bac1\",\n \"displayNumber\": 31199,\n \"handles\": {\n \"facebook\": [\n {\n \"@class\": \"FacebookSpecificAuthorData\",\n \"lswUuid\": \"30e3fe36-a970-451f-a479-2cc47ad1b9a0\",\n \"displayNumber\": 30025,\n \"profileUrl\": \"\",\n \"name\": \"1219614414830744\",\n \"scopedIds\": [\n {\n \"id\": \"1219614414830744\",\n \"instance\": \"1009123765820374\",\n \"scope\": \"PAGE\"\n }\n ],\n \"id\": \"227560774117552\",\n \"screenName\": \"Violet Estabrook\",\n \"providerInstanceId\": \"facebook\",\n \"profileImageURL\": \"https://graph.facebook.com/227560774117552/picture\",\n \"networkinstance\": \"facebook\",\n \"avatarUrl\": \"https://graph.facebook.com/227560774117552/picture\"\n }\n ],\n \"external\": [\n {\n \"@class\": \"ExternalSpecificAuthorData\",\n \"lswUuid\": \"91c84858-f62a-430e-9d5d-3f9ef876f0a4\",\n \"displayNumber\": 100738623,\n \"profileUrl\": \"\",\n \"id\": \"30e3fe36-a970-451f-a479-2cc47ad1b9a0\",\n \"name\": \"1219614414830744\",\n \"providerInstanceId\": \"smooch\",\n \"profileImageURL\": \"https://graph.facebook.com/227560774117552/picture\",\n \"networkinstance\": \"smooch\",\n \"avatarUrl\": \"https://graph.facebook.com/227560774117552/picture\"\n }\n ]\n },\n \"tags\": [\n {\n \"creator\": {\n \"type\": \"AGENT\"\n },\n \"tagId\": 28724,\n \"lswUuid\": \"7b84200c-54fe-4a01-a7db-b1118b83bead\"\n }\n ],\n \"notes\": []\n }\n ]\n}"
schema:
type: object
properties:
status:
type: string
example: success
data:
type: array
items:
type: object
properties:
id:
type: string
example: 1af519d7-7638-4f50-9276-a020f845bac1
displayNumber:
type: integer
example: 31199
default: 0
handles:
type: object
properties:
facebook:
type: array
items:
type: object
properties:
'@class':
type: string
example: FacebookSpecificAuthorData
lswUuid:
type: string
example: 30e3fe36-a970-451f-a479-2cc47ad1b9a0
displayNumber:
type: integer
example: 30025
default: 0
profileUrl:
type: string
example: ''
name:
type: string
example: '1219614414830744'
scopedIds:
type: array
items:
type: object
properties:
id:
type: string
example: '1219614414830744'
instance:
type: string
example: '1009123765820374'
scope:
type: string
example: PAGE
id:
type: string
example: '227560774117552'
screenName:
type: string
example: Violet Estabrook
providerInstanceId:
type: string
example: facebook
profileImageURL:
type: string
example: https://graph.facebook.com/227560774117552/picture
networkinstance:
type: string
example: facebook
avatarUrl:
type: string
example: https://graph.facebook.com/227560774117552/picture
external:
type: array
items:
type: object
properties:
'@class':
type: string
example: ExternalSpecificAuthorData
lswUuid:
type: string
example: 91c84858-f62a-430e-9d5d-3f9ef876f0a4
displayNumber:
type: integer
example: 100738623
default: 0
profileUrl:
type: string
example: ''
id:
type: string
example: 30e3fe36-a970-451f-a479-2cc47ad1b9a0
name:
type: string
example: '1219614414830744'
providerInstanceId:
type: string
example: smooch
profileImageURL:
type: string
example: https://graph.facebook.com/227560774117552/picture
networkinstance:
type: string
example: smooch
avatarUrl:
type: string
example: https://graph.facebook.com/227560774117552/picture
tags:
type: array
items:
type: object
properties:
creator:
type: object
properties:
type:
type: string
example: AGENT
tagId:
type: integer
example: 28724
default: 0
lswUuid:
type: string
example: 7b84200c-54fe-4a01-a7db-b1118b83bead
notes:
type: array
items:
type: object
properties: {}
'400':
description: '400'
content:
application/json:
examples:
Unsupported network type:
value: "{\n \"status\": \"fail\",\n \"message\": \"Error parsing HTTP body. Error details: Unsupported author data container format! (through reference chain: Person[\\\"handles\\\"])\"\n}"
schema:
type: object
properties:
status:
type: string
example: fail
message:
type: string
example: 'Error parsing HTTP body. Error details: Unsupported author data container format! (through reference chain: Person["handles"])'
deprecated: false
security: []
x-readme:
code-samples:
- language: curl
code: curl -L -u [USERNAME]:[PASSWORD] 'https://your_social_response_instance.lithium.com/api/v2/authors/networks/facebook/ids/1219614414830744'
samples-languages:
- curl
tags:
- Networks
put:
summary: Update author by source network ID
description: Update a single author by source network ID on the default instance of the source network
operationId: authorsnetworksnetworktypeidsnetworkid-1
parameters:
- name: networktype
in: path
description: 'The type of network that manages content created by or about an author. Supported values are: "instagram", "facebook", "googleplus", "lithium", "crm"<br><br>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 Instagram, Facebook, or Google+ that have only a single, default network.<br><br>The Author API supports "instagram", "facebook", "googleplus", "lithium", and "crm" only as values for `networktype`.'
schema:
type: string
required: true
- name: networkid
in: path
description: The internal ID of the author generated by the network. For Facebook, this is the PSID. Compare this to the the externally used `networkhandle`. The network ID must be unique to a given `networkinstance`.
schema:
type: string
required: true
responses:
'200':
description: '200'
content:
application/json:
examples:
Result:
value: '{}'
schema:
type: object
properties: {}
'400':
description: '400'
content:
application/json:
examples:
Result:
value: '{}'
schema:
type: object
properties: {}
deprecated: false
security: []
x-readme:
code-samples:
- language: http
code: https://your_social_response_instance.lithium.com/api/v2/authors/networks/twitter/ids/15165502
samples-languages:
- http
tags:
- Networks
/networks/{networktype}/instances/{networkinstance}/ids/{networkid}:
get:
summary: Get author by source network ID per instance
description: Get a single author by the source network ID on a specific instance of the network
operationId: authorsnetworksnetworktypeinstancesnetworkinstanceidsnetworkid-1
parameters:
- name: networktype
in: path
description: 'The type of network that manages content created by or about an author. Supported values are: "instagram", "facebook", "googleplus", "lithium", "crm"<br><br>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.<br><br>The Author API supports "instagram", "facebook", "googleplus", "lithium", and "crm" only as values for `networktype`.'
schema:
type: string
required: true
- name: networkinstance
in: path
description: 'The specific, uniquely-identifiable instance of a `networktype`. Use this argument with a `networktype` of "lithium" or "crm" only because other network types such as Facebook, Instagram, and Google+ have only a single, default instance.<br><br>If you wanted to PUT or GET author data by passing in a CRM author ID, for example, you would need to specify which CRM instance the CRM author ID is associated with.<br><br>Example: "sfdc_1"<br><br>The value to pass for `networkinstance` is either the instance of your Lithium community (example: https://my_community_instance.com) or the key you defined for the CRM author integration for this CRM (example: "sfdc_1").'
schema:
type: string
required: true
- name: networkid
in: path
description: The internal ID of the author generated by the network. For Facebook, this is the PSID. Compare this to the the externally used `networkhandle`. The network ID must be unique to a given `networkinstance`.
schema:
type: string
required: true
- name: include_deleted_crm
in: query
description: 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.
schema:
type: boolean
default: false
responses:
'200':
description: '200'
content:
application/json:
examples:
Result:
value: "{\n \"status\": \"success\",\n \"data\": [\n {\n \"id\": \"c1ee6be0-07b4-4828-8699-7c96ed34e6e8\",\n \"displayNumber\": 5265,\n \"handles\": {\n \"lithium\": [\n {\n \"@class\": \"LithiumSpecificAuthorData\",\n \"lswUuid\": \"e662a2c8-1cfb-43e1-879d-0bf33f4a62a7\",\n \"displayNumber\": 5090,\n \"profileUrl\": \"https://brand_community.lithium.com/t5/user/viewprofilepage/user-id/2281\",\n \"acceptedSolutionsCount\": 3,\n \"providerInstanceId\": \"liaresponse.stage.lithium.com/\",\n \"kudosCount\": 24,\n \"name\": \"Mark_Erickson\",\n \"netOverallPosts\": 299,\n \"id\": \"2281\",\n \"rankName\": \"Regular Responder\",\n \"registrationInstant\": 1361820315000,\n \"screenName\": \"Mark_Erickson\",\n \"profileImageURL\": \"https://brand_community.lithium.com/t5/image/serverpage/avatar-name/mexican/avatar-theme/2delicious/avatar-collection/food/avatar-display-size/profile/version/2?xdesc=1.0\",\n \"networkinstance\": \"liaresponse.stage.lithium.com/\",\n \"avatarUrl\": \"https://brand_community.lithium.com/t5/image/serverpage/avatar-name/mexican/avatar-theme/2delicious/avatar-collection/food/avatar-display-size/profile/version/2?xdesc=1.0\"\n }\n ]\n },\n \"tags\": [],\n \"notes\": []\n }\n ]\n}"
schema:
type: object
properties:
status:
type: string
example: success
data:
type: array
items:
type: object
properties:
id:
type: string
example: c1ee6be0-07b4-4828-8699-7c96ed34e6e8
displayNumber:
type: integer
example: 5265
default: 0
handles:
type: object
properties:
lithium:
type: array
items:
type: object
properties:
'@class':
type: string
example: LithiumSpecificAuthorData
lswUuid:
type: string
example: e662a2c8-1cfb-43e1-879d-0bf33f4a62a7
displayNumber:
type: integer
example: 5090
default: 0
profileUrl:
type: string
example: https://brand_community.lithium.com/t5/user/viewprofilepage/user-id/2281
acceptedSolutionsCount:
type: integer
example: 3
default: 0
providerInstanceId:
type: string
example: liaresponse.stage.lithium.com/
kudosCount:
type: integer
example: 24
default: 0
name:
type: string
example: Mark_Erickson
netOverallPosts:
type: integer
example: 299
default: 0
id:
type: string
example: '2281'
rankName:
type: string
example: Regular Responder
registrationInstant:
type: integer
example: 1361820315000
default: 0
screenName:
type: string
example: Mark_Erickson
profileImageURL:
type: string
example: https://brand_community.lithium.com/t5/image/serverpage/avatar-name/mexican/avatar-theme/2delicious/avatar-collection/food/avatar-display-size/profile/version/2?xdesc=1.0
networkinstance:
type: string
example: liaresponse.stage.lithium.com/
avatarUrl:
type: string
example: https://brand_community.lithium.com/t5/image/serverpage/avatar-name/mexican/avatar-theme/2delicious/avatar-collection/food/avatar-display-size/profile/version/2?xdesc=1.0
tags:
type: array
items:
type: object
properties: {}
notes:
type: array
items:
type: object
properties: {}
'400':
description: '400'
content:
application/json:
examples:
Unsupported network type:
value: "{\n \"status\": \"fail\",\n \"message\": \"Error parsing HTTP body. Error details: Unsupported author data container format! (through reference chain: Person[\\\"handles\\\"])\"\n}"
schema:
type: object
properties:
status:
type: string
example: fail
message:
type: string
example: 'Error parsing HTTP body. Error details: Unsupported author data container format! (through reference chain: Person["handles"])'
deprecated: false
security: []
x-readme:
code-samples:
- language: curl
code: curl -L -u [USERNAME]:[PASSWORD] 'https://your_social_response_instance.lithium.com/api/v2/authors/networks/lithium/instances/liaresponse.stage.lithium.com%2F/ids/2281'
samples-languages:
- curl
tags:
- Networks
put:
summary: Update author by network ID and instance
description: Update a single author by network ID on a specific instance of that network
operationId: authorsnetworksnetworktypeinstancesnetworkinstanceidsnetworkid-2
parameters:
- name: networktype
in: path
description: 'The type of network that manages content created by or about an author. Supported values are: "instagram", "facebook", "googleplus", "lithium", "crm"<br><br>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.<br><br>The Author API supports "instagram", "facebook", "googleplus", "lithium", and "crm" only as values for `networktype`.'
schema:
type: string
required: true
- name: networkinstance
in: path
description: 'The specific, uniquely-identifiable instance of a `networktype`. Use this argument with a `networktype` of "lithium" or "crm" only because other network types such as Facebook, Instagram, and Google+ have only a single, default instance.<br><br>If you wanted to PUT or GET author data by passing in a CRM author ID, for example, you would need to specify which CRM instance the CRM author ID is associated with.<br><br>Example: "sfdc_1"<br><br>The value to pass for `networkinstance` is either the instance of your Lithium community (example: https://my_community_instance.com) or the key you defined for the CRM author integration for this CRM (example: "sfdc_1").'
schema:
type: string
required: true
- name: networkid
in: path
description: The internal ID of the author generated by the network. For Facebook, this is the PSID. Compare this to the the externally used `networkhandle`. The network ID must be unique to a given `networkinstance`.
schema:
type: string
required: true
responses:
'200':
description: '200'
content:
application/json:
examples:
Result:
value: '{}'
schema:
type: object
properties: {}
'400':
description: '400'
content:
application/json:
examples:
Unsupported network type:
value: "{\n \"status\": \"fail\",\n \"message\": \"Error parsing HTTP body. Error details: Unsupported author data container format! (through reference chain: Person[\\\"handles\\\"])\"\n}"
schema:
type: object
properties:
status:
type: string
example: fail
message:
type: string
example: 'Error parsing HTTP body. Error details: Unsupported author data container format! (through reference chain: Person["handles"])'
deprecated: false
security: []
tags:
- Networks
/networks/{networktype}/handles/{networkhandle}:
get:
summary: Get author(s) by network handle
description: Get one or more authors by the `networkhandle` passed in for the specified source channel
operationId: authorsnetworks_networktype_handles_networkhandle
parameters:
- name: networktype
in: path
description: 'The type of network that manages content created by or about an author. Supported values are: "instagram", "facebook", "googleplus", "lithium", "crm"<br><br>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.<br><br>The Author API supports "instagram", "facebook", "googleplus", "lithium", and "crm" only as values for `networktype`.'
schema:
type: string
required: true
- name: networkhandle
in: path
description: 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.
schema:
type: string
required: true
- name: include_deleted_crm
in: query
description: 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.
schema:
type: boolean
default: false
responses:
'200':
description: '200'
content:
application/json:
examples:
Result:
value: "{\n \"status\": \"success\",\n \"data\": [\n {\n \"id\": \"2134086e-9024-4c3b-ab3b-afc6a36ea61c\",\n \"displayNumber\": 13366,\n \"handles\": {\n \"external\": [\n {\n \"@class\": \"ExternalSpecificAuthorData\",\n \"lswUuid\": \"edce6d32-ee19-4740-87b8-a9b69afd677d\",\n \"displayNumber\": 77285,\n \"profileUrl\": \"\",\n \"id\": \"73292839-fb73-4b2c-b7b6-32db4b2f855a\",\n \"name\": \"Anusuya_user\",\n \"screenName\": \"Anusuya_user\",\n \"providerInstanceId\": \"smooch\",\n \"profileImageURL\": \"http://pbs.twimg.com/profile_images/768361121761722368/5yZ2HHxu_normal.jpg\",\n \"networkinstance\": \"smooch\",\n \"avatarUrl\": \"http://pbs.twimg.com/profile_images/768361121761722368/5yZ2HHxu_normal.jpg\"\n }\n ],\n \"twitter\": [\n {\n \"@class\": \"TwitterSpecificAuthorData\",\n \"lswUuid\": \"73292839-fb73-4b2c-b7b6-32db4b2f855a\",\n \"displayNumber\": 12833,\n \"profileUrl\": \"http://twitter.com/anusuya_user\",\n \"id\": \"768360234377064449\",\n \"location\": \"India\",\n \"name\": \"Anusuya_user\",\n \"screenName\": \"anusuya_user\",\n \"following\": 5,\n \"followers\": 5,\n \"verified\": false,\n \"joinDate\": 1472026330163,\n \"updatesCount\": 194,\n \"languages\": \"en\",\n \"timezone\": \"null\",\n \"klout_score\": 19.737528730467623,\n \"providerInstanceId\": \"twitter\",\n \"profileImageURL\": \"https://pbs.twimg.com/profile_images/768361121761722368/5yZ2HHxu_normal.jpg\",\n \"networkinstance\": \"twitter\",\n \"avatarUrl\": \"https://pbs.twimg.com/profile_images/768361121761722368/5yZ2HHxu_normal.jpg\"\n }\n ]\n },\n \"tags\": [\n {\n \"creator\": {\n \"type\": \"AGENT\"\n },\n \"tagId\": 14865,\n \"lswUuid\": \"b8fee328-3676-4dd8-bab5-162c2417650e\"\n }\n ],\n \"notes\": [],\n \"timezone\": [\n \"-21600\"\n ]\n }\n ]\n}"
schema:
type: object
properties:
status:
type: string
example: success
data:
type: array
items:
type: object
properties:
id:
type: string
example: 2134086e-9024-4c3b-ab3b-afc6a36ea61c
displayNumber:
type: integer
example: 13366
default: 0
handles:
type: object
properties:
external:
type: array
items:
type: object
properties:
'@class':
type: s
# --- truncated at 32 KB (112 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/lithium/refs/heads/main/openapi/lithium-networks-api-openapi.yml