Versions Compared
Key
- This line was added.
- This line was removed.
- Formatting was changed.
Background
This REST API is meant to provide details of the user segments in UpRaise company directory.
API Details
This API will require valid authentication & will expect the user API token in the request.
Read Create User API token for more details
Request
Below are the endpoints for this API based on which UpRaise app you are using
App name | Endpoint |
|---|---|
UpRaise for Employee Success | https://employee-success.upraise.io/rest/upraise/public/1.0/directory/segments |
UpRaise People | https://people.upraise.io/rest/upraise/public/1.0/directory/segments |
UpRaise Employee Garrison | https://garrison.upraise.io/rest/upraise/public/1.0/directory/segments |
Sample JSON response
| Code Block |
|---|
{
"startAt": 0,
"maxResults": 8,
"total": 8,
"results": [
{
"id": 23626,
"name": "All users",
"category": "default segments"
},
{
"id": 24146,
"name": "Active users",
"category": "default segments"
},
{
"id": 24147,
"name": "Inactive users",
"category": "default segments"
},
{
"id": 24148,
"name": "Deleted users",
"category": "default segments"
},
{
"id": 23947,
"name": "teams",
"category": "my segments"
},
{
"id": 24624,
"name": "chart segment",
"category": "my segments"
},
{
"id": 23932,
"name": "QA Team",
"category": "segments shared with me"
},
{
"id": 24055,
"name": "testx1",
"category": "segments shared with me"
}
]
} |
Response parameters
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 | |
results | ObjectArray | This object Array contains all the results of the teams retrived from this API | ||
id | Number | Segment ID | 67, 89, etc. | |
name | String | Name of the Segment |
| |
category | String | Segment category |
|
On this page | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
| Iframe | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
|