Search users

Searches users with optional NM-store system context support and query validation.

RBAC · user

Query parameters

querystringRequired

fieldsstringOptional

Controller query parser sends strings; schema expects an array of field names.

user_typestringOptional

role_idstring <uuid>Optional

team_idstring <uuid>Optional

include_inactivestringOptional

limitstringOptional

Response body

Success response 200 · schema AccessApiPaginatedV1

dataarray of objectRequired

itemsobject

paginationobjectRequired

pageintegerRequired

limitintegerRequired

totalintegerRequired

totalPagesintegerRequired

hasNextbooleanRequired

hasPrevbooleanRequired

metaobject

Response codes

200

Paginated result set returned.

400

Validation failed (payload/query/path parsing).

401

API key missing/invalid or key user not found.

403

RBAC denied for user:read.

500

Unexpected controller/service failure.

GET /api/v1/users/search

cURL

curl -X GET "https://algapsa.com/api/v1/users/search?query=string&fields=string&user_type=internal&role_id=01HN2K7VRB9PQ3Y0000000000&team_id=01HN2K7VRB9PQ3Y0000000000&include_inactive=true" \
  -H "X-API-Key: $ALGA_API_KEY"

TypeScript

const response = await fetch("https://algapsa.com/api/v1/users/search?query=string&fields=string&user_type=internal&role_id=01HN2K7VRB9PQ3Y0000000000&team_id=01HN2K7VRB9PQ3Y0000000000&include_inactive=true", {
  method: "GET",
  headers: {
    "X-API-Key": "$ALGA_API_KEY",
  }
});
const data = await response.json();

using var client = new HttpClient();
using var request = new HttpRequestMessage(HttpMethod.Get, "https://algapsa.com/api/v1/users/search?query=string&fields=string&user_type=internal&role_id=01HN2K7VRB9PQ3Y0000000000&team_id=01HN2K7VRB9PQ3Y0000000000&include_inactive=true");
request.Headers.TryAddWithoutValidation("X-API-Key", "$ALGA_API_KEY");
var response = await client.SendAsync(request);
var body = await response.Content.ReadAsStringAsync();

200 OK·application/json

{
  "data": [
    {}
  ],
  "pagination": {
    "page": 1,
    "limit": 1,
    "total": 1,
    "totalPages": 1,
    "hasNext": false,
    "hasPrev": false
  },
  "meta": {}
}