| Name | Description |
|---|---|
| access_token | JSON Web Token retrieved from the Sessions endpoint (you can also passthis into the Authorization header) |
| filters |
comma delimited filters. currently options: - filters[ids] = 3,4 (if you are wanting a specific list of organizations) - filters[exclude_ids] = 1,2 (if you want to skip specific organizations) - filters[assigned_tos]=me,3 (list of people who will have assignments on desired organizations) - filters[terminology]=Organization (will scope response to orgs which are labeled as Organization) |
| page |
pagination details: - page[limit] = number of organizations you want to receive per page, default 25 - page[offset] = skip the first n number of records before reading organizations, default 0 |
| sort | order you want to receive organizations in, defaults to name. If you use `active_people_count` it will also include the number of active assignments on each organization. |
| fields | A comma separated list of fields to return in the response for the given type. A resource object's attributes and its relationships are collectively called its 'fields'. Clients may restrict the set of fields in order to improve performance. Multiple types can be specified. If no fields param is specified then by default all fields are returned. Example |
| Name | Description |
|---|---|
| data | primary JSON API payload |
| included | related models (controlled by the include param) |
| meta | will contain additional information about the current request, including the total number of records before the limit/offset operations |
Version: HTTP/1.0 Accept: application/vnd.api+json Content-Type: application/vnd.api+json Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoxNDgsImV4cCI6MTcwNDQ3MzIzMywiaWF0IjoxNzA0NDczMDUzfQ.v4l0qLK9L5fQYPdzeRXj2ycAwZwzDd46Ib8Nh0zM9_c Host: example.org Cookie:
GET /apis/v4/organizations
X-Frame-Options: SAMEORIGIN X-XSS-Protection: 1; mode=block X-Content-Type-Options: nosniff X-Download-Options: noopen X-Permitted-Cross-Domain-Policies: none Referrer-Policy: strict-origin-when-cross-origin Content-Type: application/vnd.api+json Vary: Accept X-MH-Session: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoxNDgsImV4cCI6MTcwNDY0NTg1MywiaWF0IjoxNzA0NDczMDUzfQ.VSIC-ZlBGkcN10sq5hlyB4cIAei3yITWL_rSpXddHAc Access-Control-Expose-Headers: X-MH-Session ETag: W/"98ee72fe5649e58ee29c86de7ffff9a7" Cache-Control: max-age=0, private, must-revalidate X-Request-Id: d7e413e0-5b32-4893-9065-dd28248c70a6 X-Runtime: 0.028581 Content-Length: 894
200