Runframe
API Reference

Users

Runframe V1 users API. Search people by name or email to resolve assignee and resolver IDs.

Use this endpoint to resolve a person name or email before filtering incidents by assignee or resolver.


List Users

GET /api/v1/users
ParameterTypeDescription
searchstringSearch by name or email
is_activebooleanOptional active-state filter (true or false)
limitintegerResults per page (max 100, default 20)
offsetintegerPagination offset (default 0)

Response:

{
  "success": true,
  "data": {
    "items": [
      {
        "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
        "name": "Niketa Shah",
        "email": "niketa@runframe.io",
        "is_active": true
      }
    ],
    "total": 1,
    "has_more": false,
    "next_offset": null
  }
}

Typical usage:

  1. Search for "Niketa"
  2. If one result is returned, use that id
  3. Filter incidents with:
    • assigned_to=<user_uuid>
    • resolved_by=<user_uuid>

On this page