See api-docs Menu
  1. Home >
  2. API >
  3. v1-v3 >
  4. Groups >
  5. Get All Groups

v1-v3 APIs have been deprecated

Don't worry, these APIs are deprecated, but they aren't shut off yet.

All new development with APIs should use the newest version of our API: /1. API /1 is based on RESTful principles, is secured by OAuth 2.0, and provides JSON messages, search, pagination, sorting, and filtering.

Get All Groups

Think of groups as departments. Groups enable you to split your user base into smaller pieces that can be more easily managed.

For more info, see Groups.

Resource URL

https://api.onelogin.com/api/v1/groups.xml

Sample Response

  • 200 OK
<groups type="array">
  <group>
    <id>412878</id>
    <name>Engineering</name>
    <reference nil="true"></reference>
  </group>
  <group>
    <id>412877</id>
    <name>Design</name>
    <reference nil="true"></reference>
  </group>
  <group>
    <id>412876</id>
    <name>Product</name>
    <reference nil="true"></reference>
  </group>
  <group>
    <id>412875</id>
    <name>Customer Success</name>
    <reference nil="true"></reference>
  </group>
  <group>
    <id>412874</id>
    <name>Sales</name>
    <reference nil="true"></reference>
  </group>
</groups>

Response Elements

id

Group’s unique ID in OneLogin.

name

Group name.

reference

Deprecated. Will always display the attribute nil="true".

Sample cURL Request

Be sure to replace placeholder values surrounded by { } with actual values.

curl -u {api_key}:x -X GET https://api.onelogin.com/api/v1/groups.xml

Postman Collection

Be sure to set Postman-specific environment variables indicated by {{ }}.

Download for the Groups API

Have a Question?

Found a problem or a bug? Submit a support ticket.

Looking for walkthroughs or how-to guides on OneLogin's user and admin features? Check out the documentation in our Knowledge Base.

Have a product idea or request? Share it with us in our Ideas Portal.