Get Review Group

GET

/api/v1/review_groups/{id}

const url = 'https://example.com/%7B%7Bapp_url%7D/api/v1/review_groups/1';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

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

Retrieves a single review group by ID.

Authorizations

OAuth2
review_groups:read

Parameters

Path Parameters

required

integer

Review Group ID

Responses

200

Successful

application/json

object

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
object

object

type

required

string

Allowed values: User

required

integer

first_name

required

string

last_name

required

string

profile_image_url

required

string

nullable

Example

{
  "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"
          }
        }
      ]
    }
  ]
}

401

Unauthorized

application/json

object

message

required

string

Example

{
  "message": "Record not found"
}

403

Forbidden

application/json

object

message

required

string

Example

{
  "message": "Record not found"
}

404

Not Found

application/json

object

message

required

string

Example

{
  "message": "Record not found"
}