Groups

Create Account Group

post

/api/groups

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

x-session-idstringRequired

Session authentication. The session ID can be provided in any of the following ways: [Cookie: 'session'] [Header: 'x-session-id'] [Query parameter: 'session-id'] [Query parameter: first value of 'state'] [Body property: 'sessionId']

Body

namestring · min: 1 · max: 50Optional

The desired name for the group

Responses

201

The newly created group

application/json

4XX

Bad Request

application/json

post

/api/groups

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

/api/groups

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

x-session-idstringRequired

Responses

200

An array of the groups for the account

application/json

4XX

Bad Request

application/json

get

/api/groups

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

/api/groups/{id}

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

x-session-idstringRequired

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

idstringOptional

The unique identifier for the group

namestringOptional

The name of the group

accountIdstringOptional

The account ID to which the group belongs

4XX

Bad Request

application/json

put

/api/groups/{id}

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

/api/groups/{id}

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

x-session-idstringRequired

Path parameters

idstringRequired

The group id

Responses

200

The group object

application/json

idstringOptional

The unique identifier for the group

namestringOptional

The name of the group

accountIdstringOptional

The account ID to which the group belongs

4XX

Bad Request

application/json

get

/api/groups/{id}

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

/api/groups/{id}

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

x-session-idstringRequired

Path parameters

idstringRequired

The group id

Responses

204

No Content

4XX

Bad Request

application/json

delete

/api/groups/{id}

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

No content

PreviousGroupmembers NextLicenses

Last updated 8 months ago

Was this helpful?

hashtagCreate Account Group

hashtagList all groups for an account

hashtagRename Account Group

hashtagGet group by id

hashtagDelete a group

Create Account Group

List all groups for an account

Rename Account Group

Get group by id

Delete a group