get_assignments

Endpoint#

Property	Value
Type	query
Method	GET
Path	/api/external/v1/get_assignments
Handler	OperatelyWeb.Api.Queries.GetAssignments

Authentication#

• Requires a valid API token.
• Read-only and full-access tokens can execute this query.

Inputs#

This endpoint has no input fields.

Outputs#

Field	Type	Required	Nullable
assignments	array of review_assignment object	Yes	No

cURL Example#

Copied

curl --request GET \
  --url "https://app.operately.com/api/external/v1/get_assignments" \
  --header "Authorization: Bearer ${OPERATELY_API_TOKEN}"

Response Example#

{
  "assignments": [
    {
      "action_label": "value",
      "author_id": "value",
      "author_name": "value",
      "description": "value",
      "due": "2026-01-01",
      "name": "value",
      "origin": "<review_assignment_origin>",
      "path": "value",
      "resource_id": "value",
      "role": "owner",
      "task_status": "value",
      "type": "check_in"
    }
  ]
}