Returns organization's positions
| Name | Description | Type | Additional information |
|---|---|---|---|
| hasMembers |
Only pull positions with or without members |
boolean | |
| includeArchived | boolean |
Default value is False |
|
| startDate |
Only pull positions created on or after this date |
date | |
| endDate |
Only pull positions created on or before this date |
date | |
| page |
Page number (starting page is 1) |
integer |
Default value is 1 |
| pageSize |
Number of results to return (defaults to 25, max of 200) |
integer |
Default value is 25 |
| externalId |
Search by external identifier |
string | |
| externalIdSet |
Filter positions by external identifier assignment. Set this to true to return all positions which have an external identifier set and set it to false to return positions without an external identifier |
boolean |
None.
https://api.servicereef.com/v1/positions?hasMembers={hasMembers}&includeArchived={includeArchived}&startDate={startDate}&endDate={endDate}&page={page}&pageSize={pageSize}&externalId={externalId}&externalIdSet={externalIdSet}
| Name | Description | Type | Additional information |
|---|---|---|---|
| PageInfo | PageModel | ||
| Results | Collection of OrganizationPositionResult |
Try this endpoint by entering your credentials and using the API Explorer.
Try With API Explorer
{
"PageInfo": {
"TotalRecords": 1,
"Page": 2,
"PageSize": 3
},
"Results": [
{
"DateCreated": "2024-12-22T18:34:47.4014122Z",
"MaxMembersAssigned": 1,
"NumberOfAssignedMembers": 2,
"NumberOfInquiringMembers": 3,
"Budgets": [
{
"BudgetId": 1,
"BudgetItems": [
{
"Amount": 1.0,
"BudgetCategory": "sample string 2",
"BudgetStage": "sample string 3",
"Title": "sample string 4",
"Description": "sample string 5",
"Frequency": "OneTime",
"Name": "sample string 6",
"Quantity": 7
},
{
"Amount": 1.0,
"BudgetCategory": "sample string 2",
"BudgetStage": "sample string 3",
"Title": "sample string 4",
"Description": "sample string 5",
"Frequency": "OneTime",
"Name": "sample string 6",
"Quantity": 7
}
],
"AnnualTotal": 2.0
},
{
"BudgetId": 1,
"BudgetItems": [
{
"Amount": 1.0,
"BudgetCategory": "sample string 2",
"BudgetStage": "sample string 3",
"Title": "sample string 4",
"Description": "sample string 5",
"Frequency": "OneTime",
"Name": "sample string 6",
"Quantity": 7
},
{
"Amount": 1.0,
"BudgetCategory": "sample string 2",
"BudgetStage": "sample string 3",
"Title": "sample string 4",
"Description": "sample string 5",
"Frequency": "OneTime",
"Name": "sample string 6",
"Quantity": 7
}
],
"AnnualTotal": 2.0
}
],
"Location": {
"Latitude": 1.1,
"Longitude": 1.1,
"Address1": "sample string 1",
"Address2": "sample string 2",
"City": "sample string 3",
"State": "sample string 4",
"Zip": "sample string 5",
"Country": "sample string 6",
"Name": "sample string 7"
},
"Admins": [
{
"UserId": 1,
"FirstName": "sample string 2",
"LastName": "sample string 3",
"Email": "sample string 4"
},
{
"UserId": 1,
"FirstName": "sample string 2",
"LastName": "sample string 3",
"Email": "sample string 4"
}
],
"PositionId": 4,
"Title": "sample string 5",
"Description": "sample string 6",
"Requirements": "sample string 7",
"DateStart": "2024-12-22T18:34:47.4014122Z",
"DateEnd": "2024-12-22T18:34:47.4014122Z",
"CommitmentLength": "sample string 8",
"AnnualSalary": 1.0,
"Status": "Draft",
"ExternalId": "sample string 9"
},
{
"DateCreated": "2024-12-22T18:34:47.4014122Z",
"MaxMembersAssigned": 1,
"NumberOfAssignedMembers": 2,
"NumberOfInquiringMembers": 3,
"Budgets": [
{
"BudgetId": 1,
"BudgetItems": [
{
"Amount": 1.0,
"BudgetCategory": "sample string 2",
"BudgetStage": "sample string 3",
"Title": "sample string 4",
"Description": "sample string 5",
"Frequency": "OneTime",
"Name": "sample string 6",
"Quantity": 7
},
{
"Amount": 1.0,
"BudgetCategory": "sample string 2",
"BudgetStage": "sample string 3",
"Title": "sample string 4",
"Description": "sample string 5",
"Frequency": "OneTime",
"Name": "sample string 6",
"Quantity": 7
}
],
"AnnualTotal": 2.0
},
{
"BudgetId": 1,
"BudgetItems": [
{
"Amount": 1.0,
"BudgetCategory": "sample string 2",
"BudgetStage": "sample string 3",
"Title": "sample string 4",
"Description": "sample string 5",
"Frequency": "OneTime",
"Name": "sample string 6",
"Quantity": 7
},
{
"Amount": 1.0,
"BudgetCategory": "sample string 2",
"BudgetStage": "sample string 3",
"Title": "sample string 4",
"Description": "sample string 5",
"Frequency": "OneTime",
"Name": "sample string 6",
"Quantity": 7
}
],
"AnnualTotal": 2.0
}
],
"Location": {
"Latitude": 1.1,
"Longitude": 1.1,
"Address1": "sample string 1",
"Address2": "sample string 2",
"City": "sample string 3",
"State": "sample string 4",
"Zip": "sample string 5",
"Country": "sample string 6",
"Name": "sample string 7"
},
"Admins": [
{
"UserId": 1,
"FirstName": "sample string 2",
"LastName": "sample string 3",
"Email": "sample string 4"
},
{
"UserId": 1,
"FirstName": "sample string 2",
"LastName": "sample string 3",
"Email": "sample string 4"
}
],
"PositionId": 4,
"Title": "sample string 5",
"Description": "sample string 6",
"Requirements": "sample string 7",
"DateStart": "2024-12-22T18:34:47.4014122Z",
"DateEnd": "2024-12-22T18:34:47.4014122Z",
"CommitmentLength": "sample string 8",
"AnnualSalary": 1.0,
"Status": "Draft",
"ExternalId": "sample string 9"
}
]
}