GET /api/reach_extensions/:reach_extension_id

get a single reach_extension for the authenticated reach admin

Success Response Code: 200

Response Fields

id id of the extension Integer
name the name of the extension String
external_system_id the business system id associated with the extension Integer
group_id the group id associated with the extension Integer
url the url associated with the extension String
permanent_url a url that can be used in the browser to view this extension String
extension_type the reach extension type ["discussion", "stream", "recommend", "trends", "dynamic", "recent_thanks"]
stream_type the type of stream associated with this extension String
button_type if the extension is a reach button, the type of button that it is String
install_type the extension's install type ["html", "google_gadget", "sharepoint"]
state indicates whether the extension is currently active String
button_verb the verb associated with the button ["help", "recommend", "review", "share", "thanks"]
profile_heading describes whether the top of the extension will show the header or not Boolean
days_ago If this is a reach trends extension, the number of days that it will consider relevant for computing trends Integer
login_required whether a user is required to login to view this extension's content Boolean
token the reach token needed to be supplied to the reach sample javascript String
reach_border_style the style of the border that will be drawn on the reach iframe ["none", "solid", "dotted", "dashed", "double"]
reach_border_color the color of the border that will be drawn on the reach iframe expressed as an HTML color code String
reach_poweredby_bg the color of the background on "Powered by Reach" expressed as an HTML color code String
reach_entry_border_color the border color for reach entries expressed as an HTML color code String
reach_comment_bg the background color for reach comments expressed as an HTML color code String
reach_default_text the color of standard text for this extension expressed as an HTML color code String
reach_secondary_text the color of secondary text for this extension expressed as an HTML color code String
reach_default_link the color of standard links in this reach extension expressed as an HTML color code String
reach_secondary_link the color of secondary links in this reach extension expresseda as an HTML color code String
reach_button_border the color of the reach button border expressed as an HTML color code String
reach_button_color the color of the button text expressed as an HTML color code String
reach_button_bgcolor the color of the button background expressed as an HTML color code String
reach_button_inner_border the color of the inner border for the reach button expressed as an HTML color code String
reach_button_border_hover the color of the reach button border when the mouse hovers over it expressed as an HTML color code String
reach_button_bgcolor_hover the color of the reach button background when the mouse hovers over it expressed as an HTML color code String
reach_button_textshadow the color of text shadow of the reach button expressed as an HTML color code String
reach_social_button_border the color of the border of a reach social button expressed as an HTML color code String
reach_social_button_text the color of the text of a reach social button expressed as an HTML color code String
reach_social_button_background the color of the background of a reach social button expressed as an HTML color code String
reach_separator_color the color of reach separators expressed as an HTML color code String

Example Curl Commands

curl -X GET -v --basic -u "adminuser@socialcast.com:adminuser" https://demo.socialcast.com/api/reach_extension/12.json

Examples

GET /api/reach_extensions/1.json
200
{
  "reach_extension": {
    "id": 1,
    "name": "Réach d'Extension 1",
    "external_system_id": 8,
    "group_id": null,
    "url": "https://socialcast.socialcast.test/api/reach_extensions/1",
    "permanent_url": "https://socialcast.socialcast.test/tenant_admin/reach_extensions/1",
    "extension_type": "discussion",
    "stream_type": null,
    "button_type": null,
    "install_type": "html",
    "state": "active",
    "button_verb": "recommend",
    "profile_heading": true,
    "days_ago": 7,
    "login_required": true,
    "token": "8b3d3bf1216cb2a6c73286005f0346a5983bb0d8",
    "reach_border_style": "solid",
    "reach_border_color": "#d9d9d9",
    "reach_poweredby_bg": "#f2f2f2",
    "reach_entry_border_color": "#e5e5e5",
    "reach_comment_bg": "#efefea",
    "reach_default_text": "#404040",
    "reach_secondary_text": "#8c8c8c",
    "reach_default_link": "#187aab",
    "reach_secondary_link": "#5da2c4",
    "reach_button_border": "#6bb4d8",
    "reach_button_color": "#187aab",
    "reach_button_bgcolor": "#cde4f0",
    "reach_button_inner_border": "#fff",
    "reach_button_border_hover": "#0481c0",
    "reach_button_bgcolor_hover": "#b7d9eb",
    "reach_button_textshadow": "#fff",
    "reach_social_button_border": "#6bb4d8",
    "reach_social_button_text": "#187aab",
    "reach_social_button_background": "#cde4f0",
    "reach_separator_color": "#d9d9d9"
  }
}
GET /api/reach_extensions/1.json
200
{
  "reach_extension": {
    "id": 1,
    "name": "Réach d'Extension 1",
    "external_system_id": 8,
    "group_id": null,
    "url": "https://socialcast.socialcast.test/api/reach_extensions/1",
    "permanent_url": "https://socialcast.socialcast.test/tenant_admin/reach_extensions/1",
    "extension_type": "discussion",
    "stream_type": null,
    "button_type": null,
    "install_type": "html",
    "state": "active",
    "button_verb": "recommend",
    "profile_heading": true,
    "days_ago": 7,
    "login_required": true,
    "token": null,
    "reach_border_style": "solid",
    "reach_border_color": "#d9d9d9",
    "reach_poweredby_bg": "#f2f2f2",
    "reach_entry_border_color": "#e5e5e5",
    "reach_comment_bg": "#efefea",
    "reach_default_text": "#404040",
    "reach_secondary_text": "#8c8c8c",
    "reach_default_link": "#187aab",
    "reach_secondary_link": "#5da2c4",
    "reach_button_border": "#6bb4d8",
    "reach_button_color": "#187aab",
    "reach_button_bgcolor": "#cde4f0",
    "reach_button_inner_border": "#fff",
    "reach_button_border_hover": "#0481c0",
    "reach_button_bgcolor_hover": "#b7d9eb",
    "reach_button_textshadow": "#fff",
    "reach_social_button_border": "#6bb4d8",
    "reach_social_button_text": "#187aab",
    "reach_social_button_background": "#cde4f0",
    "reach_separator_color": "#d9d9d9"
  }
}