People API: List assignments

Endpoint#

Property	Value
Type	query
Method	GET
Path	/api/external/v1/people/list_assignments
Handler	OperatelyWeb.Api.People.ListAssignments

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
due_soon	array of review_assignment_group object	Yes	No
needs_review	array of review_assignment_group object	Yes	No
upcoming	array of review_assignment_group object	Yes	No

cURL Example#

Copied

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

Response Example#

{
  "due_soon": [
    {
      "assignments": [
        "<review_assignment>"
      ],
      "origin": "<review_assignment_origin>"
    }
  ],
  "needs_review": [
    {
      "assignments": [
        "<review_assignment>"
      ],
      "origin": "<review_assignment_origin>"
    }
  ],
  "upcoming": [
    {
      "assignments": [
        "<review_assignment>"
      ],
      "origin": "<review_assignment_origin>"
    }
  ]
}