Endpoints

  • POST /groups - create a new group
  • GET /groups - list groups
  • GET /groups/{groupId} - get details of a group by group id

Group object

  • id (string) - the unique identifier of the group
  • membersUrl (string) - URL to list group's members from the API
  • reportersUrl (string) - URL to list reporters for group from the API
  • name (string) - the name of the group
  • url (string) - URL to fetch the group's details from the API

Create Group

POST /groups

Request Parameters (JSON)

  • name (string, required) - the name of the group

Example Response

{ 
"id": "example-group-id",
"name": "Example Group",
"membersUrl": "https://api.rise.com/groups/example-group-id/users",
"reportersUrl": "https://api.rise.com/groups/example-group-id/reporters",
"url": "https://api.rise.com/groups/example-group-id"
}

Endpoint-specific Error Codes

  • code: 'duplicate_name' - cannot create group because a group with the specified name already exists

List Groups

GET /groups

Request Parameters (Query String)

  • limit (integer, optional) - the maximum number of results to return in a single response (see Pagination); must be between 1 and 100 (defaults to 50)

Example Response

{ 
"groups": [
{
"id": "example-group-id-1",
"name": "Example Group"
"membersUrl": "https://api.rise.com/groups/example-group-id/users",
"reportersUrl": "https://api.rise.com/groups/example-group-id/reporters",
"url": "https://api.rise.com/groups/example-group-id-1"
}, ...
],
"nextUrl": "https://url-for-next-page-of-results"
}

Retrieve Group by ID

GET /groups/{groupId}

Example Response

{ 
"id": "example-group-id",
"name": "Example Group"
"membersUrl": "https://api.rise.com/groups/example-group-id/users",
"reportersUrl": "https://api.rise.com/groups/example-group-id/reporters",
"url": "https://api.rise.com/groups/example-group-id"
}

Endpoint-specific Error Codes

  • group_not_found - cannot retrieve group because group does not exist
Did this answer your question?