Methods

List Org Groups

Gets a list of all groups in an organization account. To fetch the members of an individual group, use the Get Group operation.

Authorizations:
APITokenOAuth2 (READ_USERS)
query Parameters
includeAll
boolean
Default: false

If true, include all results, that is, do not paginate. Mutually exclusive with page and pageSize (they are ignored if includeAll=true is specified).

string or number

When specified with a date and time value, response only includes the objects that are modified on or after the date and time specified. If you need to keep track of frequent changes, it may be more useful to use Get Sheet Version.

numericDates
boolean
Default: false

You can optionally choose to receive and send dates/times in numeric format, as milliseconds since the UNIX epoch (midnight on January 1, 1970 in UTC time), using the query string parameter numericDates with a value of true. This query parameter works for any API request.

page
number
Default: 1

Which page to return. Defaults to 1 if not specified. If you specify a value greater than the total number of pages, the last page of results is returned.

pageSize
number
Default: 100

The maximum number of items to return per page. Unless otherwise stated for a specific endpoint, defaults to 100. If neither pageSize nor page is specified, returns all rows in the sheet. If only page is specified, defaults to a page size of 100.

header Parameters
Authorization
string

API Access Token used to authenticate requests to Smartsheet APIs.

Example: Bearer ll352u9jujauoqz4gstvsae05

Responses

Request samples

curl https://api.smartsheet.com/2.0/groups \
-H "Authorization: Bearer ll352u9jujauoqz4gstvsae05"

Response samples

Content type
application/json
{
  • "pageNumber": 1,
  • "pageSize": 50,
  • "totalPages": 25,
  • "totalCount": 136,
  • "data": [
    ]
}

Add Group

Creates a new group.

This operation is only available to group administrators and system administrators.

Authorizations:
APITokenOAuth2 (ADMIN_USERS)
header Parameters
Authorization
string

API Access Token used to authenticate requests to Smartsheet APIs.

Example: Bearer ll352u9jujauoqz4gstvsae05
Request Body schema: application/json

Group object, limited to the following attributes:

  • name (required) -- must be unique within the organization account
  • description (optional)
  • members (optional) -- array of GroupMember objects, each limited to the following attribute:
    • email
name
string

name (required)

Must be unique within the organization account.

description
string

description (optional)

Array of objects

Responses

Request samples

Content type
application/json
{
  • "name": "API-created group",
  • "description": "Group created via API",
  • "members": [
    ]
}

Response samples

Content type
application/json
{
  • "message": "SUCCESS",
  • "resultCode": 0,
  • "result": {
    }
}

Get Group

Gets information about and an array of Group Members for the group specified in the URL.

Authorizations:
APITokenOAuth2 (READ_USERS)
path Parameters
groupId
required
number

Group Id

header Parameters
Authorization
string

API Access Token used to authenticate requests to Smartsheet APIs.

Example: Bearer ll352u9jujauoqz4gstvsae05

Responses

Request samples

curl https://api.smartsheet.com/2.0/groups/{groupId} \
-H "Authorization: Bearer ll352u9jujauoqz4gstvsae05"

Response samples

Content type
application/json
{
  • "id": 4583173393803140,
  • "name": "Group 1",
  • "description": "My group",
  • "owner": "john.doe@smartsheet.com",
  • "ownerId": 2331373580117892,
  • "createdAt": "2019-08-24T14:15:22Z",
  • "modifiedAt": "2019-08-24T14:15:22Z",
  • "data": [
    ]
}

Update Group

Updates the Group specified in the URL.

This operation is only available to group administrators and system administrators.

Authorizations:
APITokenOAuth2 (ADMIN_USERS)
path Parameters
groupId
required
number

Group Id

header Parameters
Authorization
string

API Access Token used to authenticate requests to Smartsheet APIs.

Example: Bearer ll352u9jujauoqz4gstvsae05
Request Body schema: application/json

Group object, limited to the following attributes:

  • description (optional)
  • name (optional) -- must be unique within the organization account
  • ownerId (optional): Id of an admin user to whom the group ownership is transferred
name
string

name (Optional)

Must be unique within the organization account.

description
string

Description (optional).

ownerId
number

ownerId (optional)

Id of an admin user to whom the group ownership is transferred.

Responses

Request samples

Content type
application/json
{
  • "name": "Renamed group",
  • "description": "Some new description",
  • "ownerId": 94094820842
}

Response samples

Content type
application/json
{
  • "message": "SUCCESS",
  • "resultCode": 0,
  • "result": {
    }
}

Delete Group

Deletes the group specified in the URL.

This operation is only available to group administrators and system administrators.

Authorizations:
APITokenOAuth2 (ADMIN_USERS)
path Parameters
groupId
required
number

Group Id

header Parameters
Authorization
string

API Access Token used to authenticate requests to Smartsheet APIs.

Example: Bearer ll352u9jujauoqz4gstvsae05

Responses

Request samples

curl https://api.smartsheet.com/2.0/groups/{groupId} \
-H "Authorization: Bearer ll352u9jujauoqz4gstvsae05" \
-X DELETE

Response samples

Content type
application/json
{
  • "message": "SUCCESS",
  • "resultCode": 0
}
➔ Next to Group Members Basics