GoodMemGoodMem
ReferenceAPIREST APIUsers

List human users

GET /v1/users: Requires LIST_USER on the GoodMem instance and READ_USER on each returned row.

GET
/v1/users

Requires LIST_USER on the GoodMem instance and READ_USER on each returned row. Authorization, label filtering, lifecycle filtering, and keyset pagination run in PostgreSQL. includeDeleted expands the lifecycle view but grants no access. includeEnrollmentSummary requests non-secret bootstrap posture only on active rows where MANAGE_USER_ENROLLMENT is independently authorized.

LABEL FILTERS: Label filters accept either label.<key>=<value> or label[key]=value (for example, label.environment=production or label[environment]=production).

Authorization

ApiKeyAuth
headerx-api-key<token>

Query Parameters

includeDeleted?boolean

Include readable permanent tombstones

Defaultfalse
includeEnrollmentSummary?boolean

Request non-secret enrollment posture on active rows where the caller also has MANAGE_USER_ENROLLMENT

Defaultfalse
maxResults?integer

Page size; defaults to 50 and must be between 1 and 1000

Formatint32
Default50
nextToken?string

Opaque continuation token

label?

Filter by label key-value pairs. Label filters accept either label.<key>=<value> or label[key]=value (for example, label.environment=production or label[environment]=production).

Example
{  "environment": "production",  "team": "nlp"}

Header Parameters

GoodMem-Timeout-Ms?integer

Optional waiting budget in milliseconds, measured from REST servlet ingress and shared across all internal gRPC calls. Supply one decimal integer from 1 to 86400000. Omission adds no deadline. Existing shorter deadlines still apply. Expiry returns HTTP 504 before streaming starts; after streaming starts, no successful completion event is sent. Use SSE or opt into GoodMem-Stream-Terminal for an explicit terminal outcome. Retrieval work is cooperatively cancelled. An accepted mutation may still commit after timeout or disconnect; a failed response does not imply rollback.

Formatint64
Range1 <= value <= 86400000

Response Body

User page returned

application/json
  1. response

One authorization-filtered page of human users.

users*array<>

OUTPUT_ONLY; users in stable keyset order.

nextToken?|

OUTPUT_ONLY; opaque continuation token, omitted after the final page.

Example Request
curl -X GET 'https://your-goodmem-server.example.com/v1/users' \  -H 'GoodMem-Timeout-Ms: 30000'
Example Response
{  "users": [    {      "userId": "550e8400-e29b-41d4-a716-446655440000",      "email": "[email protected]",      "displayName": "John Doe",      "username": "johndoe",      "enrollmentSummary": {        "openEnrollmentExpiresAt": 1786752000000      },      "deletedAt": 1620200000000,      "createdAt": 1620000000000,      "updatedAt": 1620100000000    }  ],  "nextToken": "string"}