Skip to content
EmailShepherdEmailShepherdDocumentation

List Review Groups

GET
/api/v1/review_groups
curl --request GET \
  --url 'https://example.com/%7B%7Bapp_url%7D/api/v1/review_groups?per=10&page=1' \
  --header 'Authorization: Bearer <token>'

Retrieves the review groups

Authorizations

Section titled “Authorizations”

Parameters

Section titled “ Parameters ”

Query Parameters

Section titled “Query Parameters”
per
integer
default: 10

Number of records per page

page
integer
default: 1

Page number

Responses

Section titled “ Responses ”

200

Section titled “200”

Successful

Media typeapplication/json
object
results
required
Array<object>
object
id
required
integer
name
required
string
reusable
required
boolean
stages
required
Array<object>
object
position
required
integer
approval_type
required
string
Allowed values: one_of all_of
members
required
Array<object>
object
user_id
required
integer
user
required
One of:
object
type
required
string
Allowed values: User
id
required
integer
first_name
required
string
last_name
required
string
profile_image_url
required
string | null
pagination
required
object
per
required
integer
page
required
integer
total
required
integer
Example
{
  "results": [
    {
      "id": 12345,
      "name": "My Review Group",
      "reusable": false,
      "stages": [
        {
          "position": 1,
          "approval_type": "one_of",
          "members": [
            {
              "user_id": 12345,
              "user": {
                "type": "User",
                "id": 12345,
                "first_name": "John",
                "last_name": "Smith",
                "profile_image_url": "https://example.com/profile.jpg"
              }
            }
          ]
        }
      ]
    }
  ],
  "pagination": {
    "per": 10,
    "page": 1,
    "total": 100
  }
}

401

Section titled “401”

Unauthorized

Media typeapplication/json
object
message
required
string
code
string
Example
{
  "message": "Record not found",
  "code": "share_link_expired"
}

403

Section titled “403”

Forbidden

Media typeapplication/json
object
message
required
string
code
string
Example
{
  "message": "Record not found",
  "code": "share_link_expired"
}

404

Section titled “404”

Not Found

Media typeapplication/json
object
message
required
string
code
string
Example
{
  "message": "Record not found",
  "code": "share_link_expired"
}