/organizations

Returns a single or multiple organization profiles, sorted by Organization Name.

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 the profile will be returned

 

INT

excludeHiddenOrganizations

The toggle for indicating whether organizations tied to a hidden organization type should be excluded from the response

 Including this parameter with the value “true” in your call will adjust the response to only include organizations assigned to an organization type that has the “Hide Organization Site” option enabled. Including this parameter with the value “false” in your call will adjust the response to include all organizations, regardless of the “Hide Organization Site” setting on the organization type.

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

BOOL

status

The status that organizations must have in order to be included in the response

Including this parameter in your call will limit the response to only include organizations with the status value specified.

Note: Accepted values include “active”, “frozen”, “locked”, “inactive”, or “all”. The value “all” will be used by default if the parameter is not explicitly set.

STRING

category

The category that organizations must have in order to be included in the response

 Including this parameter in your call will limit the response to only include organizations with the category value specified.

Note: Category names are custom values set by each institution. Log in to your system and check the Organization Administration area to see your category name values. Organizations may have any number of categories assigned to them, or none at all.

STRING

type

The type that organizations must have in order to be included in the response

 Including this parameter in your call will limit the response to only include organizations with the type value specified.

Note: Type names are custom values set by each institution. Log in to your system and check the Organization Administration area to see your category name values. Organizations may have one and only one type.

STRING

name

A string that organizations must have in their name in order to be included in the response

Including this parameter in your call will limit the response ton only include organizations with a name that matches or contains all of the value specified.

STRING

ModifiedOnStart

A date filter based on the last date that the organization record was modified

Including this parameter in your call will limit the response to only include organizations that have been modified since the date included in your call.

Note: dates must be represented in milliseconds/UTC time (e.g., November 12, 2013 is 1384232400000 milliseconds since 1/1/1970 00:00:00 which is the start of Unix Epoch Time)

 LONG

ModifiedOnEnd

A date filter based on the last date that the organization record was modified

Including this parameter in your call will limit the response to only include organizations that have been modified before the date included in your call.

Note: dates must be represented in milliseconds/UTC time (e.g., November 12, 2013 is 1384232400000 milliseconds since 1/1/1970 00:00:00 which is the start of Unix Epoch Time)

 LONG


Example: Calling for a specific organization

Sample Call:

https://yoursite/api/organizations/72 (shown below) or https://yoursite/api/organizations?organizationId=72 (response structure same as calls for multiple or all organizations)

Sample Response:

Example: Calling for all organizations in the system

Sample Call:

https://yoursite/api/organizations

Sample Response:

Was this article helpful?
0 out of 0 found this helpful
Have more questions? Submit a request

Need More Help?

Additional Support

Powered by Zendesk