List all assignments for a human review task

curl --request GET \
  --url https://flows.super.ai/api/human-review-tasks/{task_id}/assignments \
  --header 'Authorization: Bearer <token>' \
  --header 'X-API-Key: <api-key>'

import requests

url = "https://flows.super.ai/api/human-review-tasks/{task_id}/assignments"

headers = {
    "X-API-Key": "<api-key>",
    "Authorization": "Bearer <token>"
}

response = requests.get(url, headers=headers)

print(response.text)

const options = {
  method: 'GET',
  headers: {'X-API-Key': '<api-key>', Authorization: 'Bearer <token>'}
};

fetch('https://flows.super.ai/api/human-review-tasks/{task_id}/assignments', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://flows.super.ai/api/human-review-tasks/{task_id}/assignments",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "X-API-Key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://flows.super.ai/api/human-review-tasks/{task_id}/assignments"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-API-Key", "<api-key>")
	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://flows.super.ai/api/human-review-tasks/{task_id}/assignments")
  .header("X-API-Key", "<api-key>")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://flows.super.ai/api/human-review-tasks/{task_id}/assignments")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["X-API-Key"] = '<api-key>'
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

[
  {
    "created_at": "2023-11-07T05:31:56Z",
    "human_review_task_id": "550e8400-e29b-41d4-a716-446655440000",
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "modified_by": "<string>",
    "organization_id": "550e8400-e29b-41d4-a716-446655440000",
    "status": "pending",
    "updated_at": "2023-11-07T05:31:56Z",
    "user_id": "550e8400-e29b-41d4-a716-446655440000",
    "started_at": "2024-01-01T00:00:00Z",
    "user": {
      "created_at": "2023-11-07T05:31:56Z",
      "email": "<string>",
      "first_name": "<string>",
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "last_name": "<string>",
      "modified_by": "<string>",
      "organization_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "role": "<string>",
      "status": "<string>",
      "updated_at": "2023-11-07T05:31:56Z"
    }
  }
]

human-review-tasks

List all assignments for a human review task

List all assignments for a human review task.

Returns a list of all assignments (user assignments) for the specified human review task. This includes all users who have been assigned to review the task, along with their assignment status and when they started working on it.

Context:

Returns all assignments for the specified task
Includes assignment status (pending, in_progress, completed, cancelled)
Includes started_at timestamp for assignments that have been started
Only accessible if the task exists and user has access to the organization

Use Cases:

View all reviewers assigned to a task
Track which reviewers have started or completed their review
Monitor assignment status across all reviewers
Display assignment information in task management UI

Related Endpoints:

GET /human-review-tasks - List all tasks assigned to current user
POST /human-review-tasks//start - Start working on a task
POST /human-review-tasks//complete - Complete a task

GET

api

human-review-tasks

{task_id}

assignments

List all assignments for a human review task

curl --request GET \
  --url https://flows.super.ai/api/human-review-tasks/{task_id}/assignments \
  --header 'Authorization: Bearer <token>' \
  --header 'X-API-Key: <api-key>'

import requests

url = "https://flows.super.ai/api/human-review-tasks/{task_id}/assignments"

headers = {
    "X-API-Key": "<api-key>",
    "Authorization": "Bearer <token>"
}

response = requests.get(url, headers=headers)

print(response.text)

const options = {
  method: 'GET',
  headers: {'X-API-Key': '<api-key>', Authorization: 'Bearer <token>'}
};

fetch('https://flows.super.ai/api/human-review-tasks/{task_id}/assignments', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://flows.super.ai/api/human-review-tasks/{task_id}/assignments",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "X-API-Key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://flows.super.ai/api/human-review-tasks/{task_id}/assignments"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-API-Key", "<api-key>")
	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://flows.super.ai/api/human-review-tasks/{task_id}/assignments")
  .header("X-API-Key", "<api-key>")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://flows.super.ai/api/human-review-tasks/{task_id}/assignments")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["X-API-Key"] = '<api-key>'
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

[
  {
    "created_at": "2023-11-07T05:31:56Z",
    "human_review_task_id": "550e8400-e29b-41d4-a716-446655440000",
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "modified_by": "<string>",
    "organization_id": "550e8400-e29b-41d4-a716-446655440000",
    "status": "pending",
    "updated_at": "2023-11-07T05:31:56Z",
    "user_id": "550e8400-e29b-41d4-a716-446655440000",
    "started_at": "2024-01-01T00:00:00Z",
    "user": {
      "created_at": "2023-11-07T05:31:56Z",
      "email": "<string>",
      "first_name": "<string>",
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "last_name": "<string>",
      "modified_by": "<string>",
      "organization_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "role": "<string>",
      "status": "<string>",
      "updated_at": "2023-11-07T05:31:56Z"
    }
  }
]

Authorizations

X-API-Key

string

header

required

API key authentication. Include your API key in the X-API-Key header as: X-API-Key YOUR_API_KEY

Example:

X-API-Key: saf_1234567890

Authorization

string

header

required

JWT Bearer token authentication. Include your access token in the Authorization header as: Bearer YOUR_ACCESS_TOKEN

Example:

Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...

Path Parameters

task_id

string

required

Query Parameters

include_user_info

boolean

default:false

Whether to include full user information in the response. When true, the 'user' field will be populated with user details.

Response

List of assignments retrieved successfully

created_at

string<date-time>

required

human_review_task_id

string<uuid>

required

UUID of the human review task this assignment belongs to.

Example:

"550e8400-e29b-41d4-a716-446655440000"

string<uuid>

required

modified_by

string

required

organization_id

string<uuid>

required

UUID of the organization this assignment belongs to.

Example:

"550e8400-e29b-41d4-a716-446655440000"

status

string

required

Status of the assignment. Valid values: 'pending', 'in_progress', 'completed', 'cancelled'.

Example:

"pending"

updated_at

string<date-time>

required

user_id

string<uuid>

required

UUID of the user assigned to this task.

Example:

"550e8400-e29b-41d4-a716-446655440000"

started_at

string<date-time> | null

Timestamp when the user started working on this task. Null for pending assignments.

Example:

"2024-01-01T00:00:00Z"

user

UserResponse · object | null

Full user information. Only populated when include_user_info query parameter is set to true.

Show child attributes

Get a human review task by ID Complete a human review task