Community

Groups

Create Account Group

post

Create a group in the current user's account. Only administrators are allowed to perform this action.

Example:

  curl -X POST -H "X-Session-ID: 0123456789" -H "Content-Type: application/json" --data @data.json "https://lor.instructure.com/api/groups"
  data.json:
  {
    "name": "The Group Name"
  }
Authorizations
Body
namestring · min: 1 · max: 50Optional

The desired name for the group

Responses
201
The newly created group
application/json
post
POST /api/groups HTTP/1.1
Host: lor.instructure.com
x-session-id: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 25

{
  "name": "The Group Name"
}
{
  "id": "text",
  "name": "text",
  "accountId": "text"
}

List all groups for an account

get

Gets a list of all the groups the user has access to. If the user is an admin it will return all the groups in the account.

Example:

  curl -H "X-Session-ID: 0123456789" "https://lor.instructure.com/api/groups"
Authorizations
Responses
200
An array of the groups for the account
application/json
get
GET /api/groups HTTP/1.1
Host: lor.instructure.com
x-session-id: YOUR_API_KEY
Accept: */*

{
  "items": [
    {
      "id": "text",
      "name": "text",
      "accountId": "text",
      "isManager": true
    }
  ]
}

Rename Account Group

put

Update a group in the current user's account. Only an admin or manager of the group can perform this request.

Example:

  curl -X PUT -H "X-Session-ID: 0123456789" -H "Content-Type: application/json" --data @data.json "https://lor.instructure.com/api/groups/:id"
  data.json:
  {
    "name": "The Group Name"
  }
Authorizations
Path parameters
idstringRequired

The group id

Body
namestring · min: 1 · max: 50Optional

The desired name for the group

Responses
200
The updated group
application/json
put
PUT /api/groups/{id} HTTP/1.1
Host: lor.instructure.com
x-session-id: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 25

{
  "name": "The Group Name"
}
{
  "id": "text",
  "name": "text",
  "accountId": "text"
}

Get group by id

get

Get a group by its ID. Only an admin or manager of the group can use this endpoint.

Example:

  curl -H "X-Session-ID: 0123456789" "https://lor.instructure.com/api/groups/:id"
Authorizations
Path parameters
idstringRequired

The group id

Responses
200
The group object
application/json
get
GET /api/groups/{id} HTTP/1.1
Host: lor.instructure.com
x-session-id: YOUR_API_KEY
Accept: */*

{
  "id": "text",
  "name": "text",
  "accountId": "text"
}

Delete a group

delete

Deletes a group. Only Administrators are allowed to perform this action.

Example:

  curl -X DELETE -H "X-Session-ID: 01234567890" "https://lor.instructure.com/api/groups/asdf"
Authorizations
Path parameters
idstringRequired

The group id

Responses
204
No Content
delete
DELETE /api/groups/{id} HTTP/1.1
Host: lor.instructure.com
x-session-id: YOUR_API_KEY
Accept: */*

No content
PreviousGroupmembersNextLicenses

Last updated

Was this helpful?