getUsersForSegment

Background

This is a REST API meant to provide a list of all Users that are available in the given segment.

API Details

This API will require valid authentication & will expect the API token in the request.
In addition to the API token, the request for this REST API should include the ID of the User segment.

Request

Below are the endpoints for this API based on which UpRaise app you are using

App name	Endpoint

App name	Endpoint
UpRaise for Employee Success	https://employee-success.upraise.io/rest/upraise/public/1.0/directory/{segmentId}/getUsersForSegment
UpRaise People	https://people.upraise.io/rest/upraise/public/1.0/directory/{segmentId}/getUsersForSegment
UpRaise for Employee Garrison	https://employee-garrison.upraise.io/rest/upraise/public/1.0/directory/{segmentId}/getUsersForSegment

Important to note

The information returned in the API will depend on the columns that are configured to be displayed in the segment.
Important to note that only those Users that are visible to the logged-in user should be returned in the response.

On this page

On this page
1 Background 2 API Details 3 Request 4 Sample JSON response 5 Response parameters 6 Error handling

Sample JSON response

{
  "startAt": 0,
  "maxResults": 20,
  "total": 1,
  "dateTimeFormat": "dd/MMMM/yyyy HH:mm:ss aa",
  "dateFormat": "dd/MM/yy",
  "results": [
    {
      "id": 30712,
      "jiraUserRestApiUrl": "<baseURL>/rest/api/2/user?accountId=557058:abffcb82-281b-422b-ad3a-683362ccd4db",
      "manager": {
        "id": 30711,
        "jiraUserRestApiUrl": "<baseURL>/rest/api/2/user?accountId=5f21e250ef11df0025988f71"
      },
      "designation": {
        "id": 785,
        "name": "Data Analyst"
      },
      "role": {
        "id": 1232,
        "name": "User"
      },
      "teams": [
        {
          "id": 1417,
          "name": "Inactive team"
        },
        {
          "id": 1412,
          "name": "Product Team"
        },
        {
          "id": 1419,
          "name": "Test 1-1"
        },
        {
          "id": 1424,
          "name": "A team-1"
        },
        {
          "id": 1411,
          "name": "Test team"
        },
        {
          "id": 1423,
          "name": "jira team"
        },
        {
          "id": 1359,
          "name": "QA Team"
        }
      ],
      "directReports": [
        {
          "id": 30836,
          "jiraUserRestApiUrl": "<baseURL>/rest/api/2/user?accountId=63f317d789de3d475af39784"
        },
        {
          "id": 30736,
          "jiraUserRestApiUrl": "<baseURL>/rest/api/2/user?accountId=557058:34a7bd76-0c49-4a62-890b-af980864b61a"
        }
      ],
      "leavePolicy": {
        "id": 780,
        "name": "Leave Policy 2024 - 2"
      },
      "holidayScheme": {
        "id": 902,
        "name": "Holiday Policy 2024 1"
      },
      "workweekScheme": {
        "id": 503,
        "name": "Workweek Scheme 2024 - 1"
      },
      "customAttributes": [
        {
          "id": 5335,
          "name": "Employment type",
          "type": "Select list (single choice)",
          "valueOptions": [
            {
              "id": 5376,
              "name": "Permanent"
            }
          ]
        },
        {
          "id": 5340,
          "name": "Job description",
          "type": "Text field (multiple line)",
          "value": "Data Analyst\nWorks in FS BU.",
          "valueInHtml": "<div><p>Data Analyst</p><p>Works in FS BU.</p></div>"
        },
        {
          "id": 5337,
          "name": "Joining date",
          "type": "Date picker",
          "value": "23/05/22"
        },
        {
          "id": 5338,
          "name": "Stay with us",
          "type": "Derived field",
          "value": "1 years, 10 months, and 18 days"
        },
        {
          "id": 5348,
          "name": "Age",
          "type": "Derived field",
          "value": "25 years, 3 months, and 26 days"
        },
        {
          "id": 5341,
          "name": "Skills",
          "type": "Select list (multiple choice)",
          "valueOptions": [
            {
              "id": 6055,
              "name": "Selenium"
            },
            {
              "id": 6054,
              "name": "Java"
            },
            {
              "id": 6059,
              "name": "C++"
            }
          ]
        },
        {
          "id": 5342,
          "name": "Location",
          "type": "Select list (single choice)",
          "valueOptions": [
            {
              "id": 5382,
              "name": "India office"
            }
          ]
        },
        {
          "id": 5948,
          "name": "Reporting Manager",
          "type": "User picker (single select)",
          "users": [
            {
              "id": 30732,
              "jiraUserRestApiUrl": "<baseURL>/rest/api/2/user?accountId=5cd625a87c13590d66b4085b"
            }
          ],
          "mappedBy": false
        },
        {
          "id": 5948,
          "name": "Reportee(s)",
          "type": "User picker (single select)",
          "users": [
            {
              "id": 30836,
              "jiraUserRestApiUrl": "<baseURL>/rest/api/2/user?accountId=63f317d789de3d475af39784"
            },
            {
              "id": 30736,
              "jiraUserRestApiUrl": "<baseURL>/rest/api/2/user?accountId=557058:34a7bd76-0c49-4a62-890b-af980864b61a"
            }
          ],
          "mappedBy": true
        },
        {
          "id": 5949,
          "name": "Trainer",
          "type": "User picker (multiple select)",
          "users": [
            {
              "id": 30733,
              "jiraUserRestApiUrl": "<baseURL>/rest/api/2/user?accountId=557058:ddd36435-e122-4033-85ec-1f7e087df147"
            },
            {
              "id": 30837,
              "jiraUserRestApiUrl": "<baseURL>/rest/api/2/user?accountId=63da09ac010d35637970cff8"
            }
          ],
          "mappedBy": false
        },
        {
          "id": 5949,
          "name": "Trainee",
          "type": "User picker (multiple select)",
          "users": [
            {
              "id": 30836,
              "jiraUserRestApiUrl": "<baseURL>/rest/api/2/user?accountId=63f317d789de3d475af39784"
            },
            {
              "id": 30736,
              "jiraUserRestApiUrl": "<baseURL>/rest/api/2/user?accountId=557058:34a7bd76-0c49-4a62-890b-af980864b61a"
            }
          ],
          "mappedBy": true
        },
        {
          "id": 5353,
          "name": "Skype",
          "type": "Text field (single line)",
          "value": "alan@skype.com"
        },
        {
          "id": 5950,
          "name": "Relevant Work Experience (in Yrs.)",
          "type": "Numeric field",
          "value": "3"
        }
      ],
      "externalId": "",
      "creator": {
        "id": 30710,
        "jiraUserRestApiUrl": "<baseURL>/rest/api/2/user?accountId=6327fe4c61dbef2805bb9a62"
      },
      "created": "19/January/2024 12:30:32 PM",
      "modifiedBy": {
        "id": 30710,
        "jiraUserRestApiUrl": "<baseURL>/rest/api/2/user?accountId=6327fe4c61dbef2805bb9a62"
      },
      "modified": "11/April/2024 08:34:47 AM"
    }
  ]
}

Response parameters

Parent	Parameter	Type	Description	Possible values

Parent	Parameter	Type	Description	Possible values
	startAt	Number	This will show the starting index for the search results.	0, 1, 2, 3, etc.
	maxResults	Number	This will show the max number of results on any given page.	Maximum allowed value of 50. If more than 50 value is sent in the request, the app will consider 50.
	total	Number	This will indicate how many results in total exist for the given search.	Any number
	dateTimeFormat	String	Format definition of date fields returned in response.	mm/MM/yy hh:mm
	dateFormat	String	Format definition of date fields returned in response.	dd/MM/yy
	results	Array	This array contains all the results of the users and attributes retrieved from this API for the given segment
results	id	Number	UpRaise User ID of the user listed in the segment	23, 7881, etc.
results	jiraUserRestApiUrl	String	Jira User Rest API URL	<baseURL>/rest/api/2/user?accountId=557058:abffcb82-281b-422b-ad3a-683362ccd4db
	manager	String	This contains the details of user’s manager	ID jiraUserRestApiUrl
manager	id	Number	UpRaise user ID of the user who is manager of the user	12, 78, etc.
manager	jiraUserRestApiUrl	String	Jira User Rest API URL	<baseURL>/rest/api/2/user?accountId=5f21e250ef11df0025988f71
	designation	String	This contains the details of user’s designation	ID name
designation	id	Number	UpRaise designation ID	12, 19, etc.
designation	name	String	Designation	Sales manager, HR manager, etc.
	role	String	This contains the details of user’s role	ID Name
role	id	Number	Role ID	12, 34, etc.
role	name	String	Role	User, Admin Super admin User with Company OKR permissions No access Any custom role
	teams	String	This contains the details of team	ID Name
teams	id	Number	Team ID in UpRaise	1, 23, etc.
teams	name	String	Team name	Sales, Operations, etc.
	directreports	String	This contains the details of user’s direct report listed in given segment	ID jiraUserRestApiUrl
directreports	id	Number	UpRaise user id of the direct report of user listed in given segment	23, 34, etc.
directreports	jiraUserRestApiUrl	String	Jira user Rest API URL of the user who is direct report	<baseURL>/rest/api/2/user?accountId=557058:abffcb82-281b-422b-ad3a-683362ccd4db
	leavePolicy	String	Current leave policy of the user in current segment	id name
leavePolicy	id	Number	ID of the leave policy	12, 50. etc.
leavePolicy	name	String	Name of the leave policy	Default leave policy On probation leave policy UK Leave policy India Leave policy
	holidayScheme	String	Current holiday scheme of the user in current segment	id name
holidayScheme	id	Number	ID of the holiday policy in UpRaise	67, 89, etc.
holidayScheme	names	String	Name of the holiday policy	Annual holiday (India) Annual holiday (UK)
	workweekScheme	String	Current workweek scheme of the user in the current segment	id name
workweekScheme	id	Number	ID of the workweek scheme in UpRaise	100, 782, etc.
workweekScheme	name	String	Name of the workweek scheme	UAE workweek India Workweek
	customAttributes	Array	This array contains all the parameters related to UpRaise user’s custom attributes
customAttributes	id	Number	UpRaise ID of the attribute
customAttributes	name	String	Name of the user attribute
customAttributes	type	String	Field type of the attribute	Select list (single choice) Select list (multiple choice) Text field (multiple line) Text field (single line) Date picker Derived field User picker (single select) User picker (multiple select) Numeric field
customAttributes	valuoptions		This parameter contains the other parameters related to value options based on the field type. For eg. if the field type is select list multiple choice then value options are option 1, option, so on.	id name
valuoptions	id	Number	Value ID of the option	7171, etc.
valuoptions	name	String	Name of the option	Option A, Option B, etc.
customAttributes	value	Number/String	Value of the option (applicable in case of fields like a single line, multiple lines, date, or numeric type fields)	Eg. Data Analyst and networks category
customAttributes	valueInHtml	String	Same value in HTML	<div><p>Data Analyst and networks category <p></div>
customAttributes	users	String	This parameter is used when the field types are single or multiple user select. This field is to define user options.	id jiraUserRestApiUrl
users	id	Number	User ID of the user available in the options	7723, 6363, etc.
users	jiraUserRestApiUrl	String	Jira use Rest API URL	<baseURL>/rest/api/2/user?accountId=5cd625a87c13590d66b4085b
customAttributes	mappedBy	String	`mappedBy` field reflects who has selected the current user in the corresponding user-picker attribute.	The `mappedBy` field indicates whether the current field is the reverse relationship of a main field. It has two possible values: `true` or `false`. If `mappedBy` is `false`, it means this is the main field. If `mappedBy` is `true`, it means this is the reverse relating field to the main field.
	externalId	Number	External ID of the user when user is fetched from HRMS tool	773, 88383, etc.
	creator	String	This contains details of the creator of the user	id jiraUserRestApiUrl
creator	id	Number	The ID of the user who has created the current user	891, 8282, etc.
creator	jiraUserRestApiUrl	String	Jira user Rest API URL of the creator	<baseURL>/rest/api/2/user?accountId=6327fe4c61dbef2805bb9a62
	created	String	Date when the user is created user	19/January/2024 12:30:32 PM
	modifiedBy	String	This contains the details of the user who modified the user	id jiraUserRestApiUrl
modifiedBy	id	Number	ID of the user who modified user	773, 8484, etc.
modifiedBy	jiraUserRestApiUrl	String	Jira Rest API URL of the user who modified the details	<baseURL>/rest/api/2/user?accountId=6327fe4c61dbef2805bb9a62
	modified	String	Date when modified.	29/January/2024 12:30:32 PM

Error handling

HTTP Status code	Error Message

HTTP Status code	Error Message
403 (FORBIDDEN)	The API token in the request is invalid. Please use a different one.