/positions

Returns the list of positions on an organization’s roster including the configuration settings specific to each position, ordered by Position ID.

Optional Parameters:

Parameter

Description

Type

page

The specific page number in a paginated list of results

 

Including this parameter in your call will limit the response to a single page matching the page sequence order represented by the page number.

 

INT

pageSize

The number of items to include in the page of results

 

Including this parameter in your call will adjust the response to only include no more than the number of items that you specify on each page.

 

Note: The value “100” will be used by default if the parameter is not explicitly set and the maximum value is “500”.

 

INT

organizationId

The ID of the specific organization for which a list of positions will be returned

 

INT

template

The name of the position template by which to filter the list of returned positions

 

All positions in the system are tied to a smaller sub-set of administratively-defined templates. Including this parameter in your call will limit the response to only include positions within the organization that are tied to the specified template.

 

STRING

type

The type of the position by which to filter the list of returned positions

 

All positions templates in the system are associated with a smaller sub-set of administratively-defined types. Including this parameter in your call will limit the response to only include positions within the organization that are tied to templates that are in turn associated with the specified type.

 

STRING

activeStatusOnly

The toggle for indicating whether only positions that are active will be returned in the response

 

Including this parameter with the value “true” in your call will adjust the response to only include positions that are currently enabled or set to “Active”. Including this parameter with the value “false” in your call will adjust the response to include both enabled and disabled (or “Active” and “Inactive”) positions.

 

Note: The value “false” will be used by default if the parameter is not explicitly set.

 

BOOL

  
Note: TotalAssignedMembers response only includes Active holder of position

Example: Calling for multiple positions

Sample Call:

https://yoursite/api/positions (returns all positions in the system) or https://yoursite/api/positions?organizationId=39 (shown below; returns all positions available within one organization)

Sample Response:

Have more questions? Submit a request