Loading ...

REST API: Get Org Chart Users | Communifire Documentation

Home » communifire documentation » Wiki » Documentation » REST API » REST API: Users » REST API: Get Org Chart Users
Communifire Documentation  Wiki
Public Space
Activity Stream Content
Version 2

REST API: Get Org Chart Users

0 
 /5
0 (0votes)

Get Org Chart Users

GET /api/orgchart/users

Get org chart users starting at a specific user. Valid for Communifire version 6.0 and above.

Method Details

HTTP Method
GET
Response Format
JSON
Requires Authentication?
YES
Product Version
6.0 and above
Required Parameters How to use Description
API Key Used in the request URL:
&token=x
OR
Set in header:
request.Headers.Add(Rest-Api-Key, x)

Communifire REST API key for the Communifire portal you are making the call for.
UserID &UserID=x - Used in the request URL as a query parameter Which user to return org chart data for.
NoOfLevels &NoOfLevels=x - Used in the request URL as a query parameter Specifies how many levels of the org chart to return.
StartNode &StartNode=x - Used in the request URL as a query parameter Set to true to return the user specified by user ID as the first node. Set to false to return the user's supervisor.
Optional Parameters How to use Description
SetUserCardHtml &SetUserCardHtml=x - Used in the request URL as a query parameter Set to true to return org chart user card HTML for all users. False by default.
SetSelectedUserCardHtml &SetSelectedUserCardHtml=x - Used in the request URL as a query parameter Set to true to return org chart user card HTML for the user specified by user ID. False by default.

Example Request

GET https://myintranet.communifire.com/api/orgchart/users?Userid=376&NoOfLevels=3&StartNode=true&SetUserCardHtml=false&SetSelectedUserCardHtml=true

Example Response

[
  {
    "FullName": "Alexis Fox",
    "Id": "376",
    "Occupation": "CEO",
    "ProfileImageURL": "https://myintranet.communifire.com/Assets/Uploaded-Photos/376/43e56923-e7c8-4089-beac-4763dfad07cd.jpeg",
    "Parent": "",
    "UserCardHtml": "<div class="ax-usr-card">\n    <div class="ax-usr-card-header" style="background: url('https://myintranet.communifire.com/Assets/Uploaded-Photos/376/23cec306-5e00-4cfb-9b49-0d62e0ba5834.jpg') no-repeat center center / cover ">\n    </div>\n    <div class="ax-usr-card-body">\n        <div class="ax-usr-card-avatar">\n            <i title="Offline" class="icon-circle status-offline"></i>\n            <a href="https://myintranet.communifire.com/people/admin"><img src="https://myintranet.communifire.com/Assets/Uploaded-Photos/376/43e56923-e7c8-4089-beac-4763dfad07cd.jpeg" class="avatar" alt=""/></a>\n        </div>\n        <div class="user-info">\n            <div class="user-name"><a href="https://myintranet.communifire.com/people/admin">Alexis Fox</a></div>\n            <div class="user-prop user-rank">\n                <img src="https://myintranet.communifire.com/Assets/Uploaded-Photos/rank-guru.gif" class="rank-image" /><span class="rank-name">Guru</span>\n            </div>\n            <div class="user-prop"><a href='mailto:raghav@axerosolutions.com' title='raghav@axerosolutions.com'>raghav@axerosolutions.com</a></div>\n            <div class="user-prop"><a href='tel:444-333-5555' title='444-333-5555'>444-333-5555</a> </div>\n            <div class="user-prop">CEO - Human Resources</div>\n            <div class="user-prop">San Diego, California</div>\n            <div class="user-prop text-left"><label>Bio</label><p>I'm excited to be able to help people achieve their potential in life, both at work and outside of the office.</p></div>\n        </div>\n    </div>\n    <div class="ax-usr-card-footer">\n        <a id="MessageButton" class="btn" type="button" target="_blank" href="/chat/user/376">Message</a>\n        <a class="btn" href="https://myintranet.communifire.com/people/admin">View Profile</a>\n    </div>\n</div>"
  },
  {
    "FullName": "Julius Kerby",
    "Id": "518",
    "Occupation": "VP Finance",
    "ProfileImageURL": "https://myintranet.communifire.com/Assets/Uploaded-Photos/518/2fde91b9-1312-4013-abbc-fa0bc663ac3e.jpg",
    "Parent": "376"
  },
  {
    "FullName": "Mark Haynes",
    "Id": "519",
    "Occupation": "VP Human Resources",
    "ProfileImageURL": "https://myintranet.communifire.com/Assets/Uploaded-Photos/519/1d67bc32-56d9-4ebf-830e-f1652c46feb1.jpg",
    "Parent": "376"
  },
  {
    "FullName": "Kathy Harris",
    "Id": "520",
    "Occupation": "VP IT",
    "ProfileImageURL": "https://myintranet.communifire.com/Assets/Uploaded-Photos/520/835a3ce4-6753-45ef-98d0-e20f9ecc51ae.jpg",
    "Parent": "376"
  },
  {
    "FullName": "Mia Wilson",
    "Id": "521",
    "Occupation": "VP Sales",
    "ProfileImageURL": "https://myintranet.communifire.com/Assets/Uploaded-Photos/521/b4da5e2c-0aa6-435b-9085-10a62a43fc2d.jpg",
    "Parent": "376"
  },
  {
    "FullName": "Raymond Flores",
    "Id": "522",
    "Occupation": "VP Marketing",
    "ProfileImageURL": "https://myintranet.communifire.com/Assets/Uploaded-Photos/522/e7f8e22d-ac52-4006-9743-0edd7b71d05d.jpg",
    "Parent": "376"
  },
  {
    "FullName": "Brett Barrington",
    "Id": "535",
    "Occupation": "Financial Analyst",
    "ProfileImageURL": "https://myintranet.communifire.com/Assets/Uploaded-Photos/535/869816d7-98b7-4e89-98f2-8db1cf676aa0.jpg",
    "Parent": "518"
  },
  {
    "FullName": "Lillie McElroy",
    "Id": "536",
    "Occupation": "Financial Analyst",
    "ProfileImageURL": "https://myintranet.communifire.com/Assets/Uploaded-Photos/536/41850af4-6da6-4ef9-b742-5883cffd041f.jpg",
    "Parent": "518"
  },
  {
    "FullName": "Brian Smith",
    "Id": "560",
    "Occupation": "Network Administrator",
    "ProfileImageURL": "https://myintranet.communifire.com/Assets/Uploaded-Photos/560/449f2544-833c-43d2-9019-eebdf9cd6af5.png",
    "Parent": "519"
  },
  {
    "FullName": "Robert Stafford",
    "Id": "561",
    "Occupation": "IT Analyst",
    "ProfileImageURL": "https://myintranet.communifire.com/Assets/Uploaded-Photos/561/3818c876-63d6-4f48-9691-64dd90a4cf32.png",
    "Parent": "519"
  },
  {
    "FullName": "Michael Stewart",
    "Id": "583",
    "Occupation": "Computer Technician",
    "ProfileImageURL": "https://myintranet.communifire.com/Assets/Uploaded-Photos/583/09e4a955-1412-49d5-bdbb-2105aa04c976.png",
    "Parent": "520"
  },
  {
    "FullName": "John Brown",
    "Id": "584",
    "Occupation": "Computer Technician",
    "ProfileImageURL": "https://myintranet.communifire.com/Assets/Uploaded-Photos/584/72282eb0-cb2c-4c95-b9ac-cfd49db89e1b.png",
    "Parent": "520"
  },
  {
    "FullName": "Alice Romero",
    "Id": "602",
    "Occupation": "Assistant",
    "ProfileImageURL": "https://myintranet.communifire.com/Assets/Uploaded-Photos/602/8ec77e10-fc0f-4a3c-8f41-67d3c38eec8d.jpg",
    "Parent": "521"
  },
  {
    "FullName": "Robert Walters",
    "Id": "603",
    "Occupation": "Sales Representative",
    "ProfileImageURL": "https://myintranet.communifire.com/Assets/Uploaded-Photos/603/8adf63b4-daf1-4b2b-8842-78eb5baf3564.jpg",
    "Parent": "521"
  },
  {
    "FullName": "Edith Reed",
    "Id": "523",
    "Occupation": "Marketing Pro",
    "ProfileImageURL": "https://myintranet.communifire.com/Assets/Uploaded-Photos/523/004d6ce3-8d13-4cf6-9c82-4e6abef4290c.png",
    "Parent": "522"
  },
  {
    "FullName": "Mark Petterson",
    "Id": "524",
    "Occupation": "Marketing Pro",
    "ProfileImageURL": "https://myintranet.communifire.com/Assets/Uploaded-Photos/524/bdcf90eb-0882-49c6-afdf-b39306bc6446.png",
    "Parent": "522"
  },
  {
    "FullName": "Maria Shears",
    "Id": "525",
    "Occupation": "Sourcer",
    "ProfileImageURL": "https://myintranet.communifire.com/Assets/Uploaded-Photos/525/44511b3a-110a-496b-9916-33ea89f4cd10.jpg",
    "Parent": "522"
  },
  {
    "FullName": "Toni Chapell",
    "Id": "526",
    "Occupation": "Marketing Pro",
    "ProfileImageURL": "https://myintranet.communifire.com/Assets/Uploaded-Photos/526/0982900c-09dd-48cb-a25f-73432cec055a.png",
    "Parent": "522"
  },
  {
    "FullName": "Laura Kirchoff",
    "Id": "527",
    "Occupation": "Marketing Pro",
    "ProfileImageURL": "https://myintranet.communifire.com/Assets/Uploaded-Photos/527/afba4567-a750-4e74-bdb9-6b895415476d.png",
    "Parent": "522"
  },
  {
    "FullName": "Joann Martinez",
    "Id": "528",
    "Occupation": "Marketing Pro",
    "ProfileImageURL": "https://myintranet.communifire.com/Assets/Uploaded-Photos/528/1a2cf299-fca7-47f6-946a-56eeb389fe13.png",
    "Parent": "522"
  },
  {
    "FullName": "Marta Pate",
    "Id": "529",
    "Occupation": "Marketing Pro",
    "ProfileImageURL": "https://myintranet.communifire.com/Assets/Uploaded-Photos/529/ba3940aa-e224-449a-b596-592793102c39.png",
    "Parent": "522"
  },
  {
    "FullName": "Virginia James",
    "Id": "530",
    "Occupation": "Marketing Pro",
    "ProfileImageURL": "https://myintranet.communifire.com/Assets/Uploaded-Photos/530/5750e2f1-f63d-4b37-ac41-cdf6d6050859.png",
    "Parent": "522"
  },
  {
    "FullName": "Mary Farrell",
    "Id": "531",
    "Occupation": "Marketing Pro",
    "ProfileImageURL": "https://myintranet.communifire.com/Assets/Uploaded-Photos/531/d27001e5-77fe-48e7-b0c7-d89de33c6999.png",
    "Parent": "522"
  },
  {
    "FullName": "Reynaldo Pagel",
    "Id": "532",
    "Occupation": "Marketing Pro",
    "ProfileImageURL": "https://myintranet.communifire.com/Assets/Uploaded-Photos/532/b5327fbd-dc1c-45ab-bbc0-23a39f67d482.png",
    "Parent": "522"
  },
  {
    "FullName": "Melissa Beck",
    "Id": "533",
    "Occupation": "Marketing Pro",
    "ProfileImageURL": "https://myintranet.communifire.com/Assets/Uploaded-Photos/533/7bf0f2ac-17f6-4062-b297-fafb37bb54ce.png",
    "Parent": "522"
  },
  {
    "FullName": "David Read",
    "Id": "534",
    "Occupation": "Marketing Pro",
    "ProfileImageURL": "https://myintranet.communifire.com/Assets/Uploaded-Photos/534/769fab16-6402-4daa-ad5b-14b2b85d1ca6.png",
    "Parent": "522"
  }
]

 

Please Note The content type that you pass in the header of your request should be application/json.

 

Wiki Index

Pages

Intranet Software