Read (GET) Organizations

Use this API to read all organizations from Configuration.

To get all organizations:

Execute a GET command on the endpoint {{url}}/organization/

For example, using cURL to submit the GET request, here is an example of how to get all organizations:

curl --request GET \
  --url 'https://{{url}}/organization' \
  --header 'authorization: Bearer {{oauth_token}}' \
  --header 'content-type: application/json'

The call returns one JSON structure like the following for each organization. The organization code that returns will not exceed 14 characters. The total length of the full organization code for the company includes characters, digits, and delimiters. The client defined values are two letters or digits that represent each organizational level up to 5 sublevels. Each level is separated by a colon or the user-defined delimiter that matches your system. In this example, "PR" could represent the company itself, "11" could represent the office or branch location, "CO" could represent a specific office location, and "22" could represent a more specific level of the organization such as a functional department.

    
    {
        "Org": "PR:11:CO:22",
        "Name": "Corporate"
    }