Get all Organizations

GET https://{{base_url}}/v3/organizations

The Get all organizations call lists all organizations related to the system user in the order that they were created.

To use the API Request, you will need to authenticate yourself either with a Management Token (highly recommended) or an Authtoken. 
Read more about it in Authentication.


For more information, refer to the Get all Organizations API Reference document

Request Params

KeyDatatypeRequiredDescription
limitnumberThe ‘limit’ parameter will return a specific number of entries in the output. Example, if there are 10 organizations and you wish to fetch only the first 2, you need to specify '2' as the value in this parameter.
skipnumberThe ‘skip’ parameter will skip a specific number of organizations in the output. Example, if there are 12 organizations and you want to skip the first 2 to get only the last 10 in the response body, you need to specify ‘2’ here.
ascstringThe ‘asc’ parameter allows you to sort the list of organizations in the ascending order with respect to the value of a specific field.
descstringThe ‘desc’ parameter allows you to sort the list of Organizations in the descending order with respect to the value of a specific field.
include_countbooleanThe ‘include_count’ parameter returns the total number of organizations related to the user. Example: If you wish to know the total number of organizations, you need to mention ‘true’.
typeaheadstringThe typeahead parameter is a type of filter that allows you to perform a name-based search on all organizations based on the value provided. Example, if we have four organizations named ‘ABC’, ‘ABC1’, ‘XYZ’, and ‘ACC’, and we provide ‘ABC’ as the value to this parameter, the search result will return the organizations ‘ABC’ and ‘ABC1’ as the output.

HEADERS

KeyDatatypeRequiredDescription
authtokenstringEnter the authtoken of the user.
Content-Typestring