GoodMemGoodMem
ReferenceAPIREST APIUsers

List human 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).

GET
/v1/users
x-api-key<token>

In: header

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

Default50
Formatint32
nextToken?string

Opaque continuation token

label?object

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"}

Empty Object

Response Body

curl -X GET "https://loading/v1/users?includeDeleted=false&includeEnrollmentSummary=false&maxResults=50&nextToken=string&label%5Benvironment%5D=production&label%5Bteam%5D=nlp"
{
  "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"
}
Empty
Empty
Empty
Empty
Empty
Empty
Empty
Empty