List users | SchematicHQ

import { SchematicClient } from "@schematichq/schematic-typescript-node";
async function main() {
    const client = new SchematicClient({
        apiKey: "YOUR_API_KEY_HERE",
    });
    await client.companies.listUsers({});
}
main();

{
  "data": [
    {
      "company_memberships": [
        {
          "company_id": "comp_1234567890abcdef",
          "created_at": "2023-11-20T08:45:00Z",
          "id": "cm_abcdef1234567890",
          "updated_at": "2024-04-01T12:00:00Z",
          "user_id": "user_9876543210fedcba",
          "company": {
            "created_at": "2023-11-20T08:45:00Z",
            "environment_id": "env_9f8e7d6c5b4a3",
            "id": "comp_1234567890abcdef",
            "name": "Acme Corporation",
            "updated_at": "2024-04-01T12:00:00Z",
            "last_seen_at": "2024-04-10T16:20:00Z",
            "logo_url": "https://example.com/logos/acme_corp.png"
          }
        }
      ],
      "created_at": "2023-11-20T08:45:00Z",
      "entity_traits": [
        {
          "created_at": "2023-11-20T08:45:00Z",
          "definition_id": "trait_0011223344556677",
          "environment_id": "env_9f8e7d6c5b4a3",
          "id": "et_8899aabbccddeeff",
          "updated_at": "2024-04-01T12:00:00Z",
          "value": "true",
          "definition": {
            "created_at": "2023-11-20T08:00:00Z",
            "display_name": "Email Verified",
            "entity_type": "user",
            "hierarchy": [
              "contact",
              "verification"
            ],
            "id": "trait_0011223344556677",
            "trait_type": "boolean",
            "updated_at": "2024-04-01T12:00:00Z"
          }
        }
      ],
      "environment_id": "env_9f8e7d6c5b4a3",
      "id": "user_9876543210fedcba",
      "keys": [
        {
          "created_at": "2023-11-20T08:45:00Z",
          "definition_id": "key_1122334455667788",
          "entity_id": "user_9876543210fedcba",
          "entity_type": "user",
          "environment_id": "env_9f8e7d6c5b4a3",
          "id": "ek_9988776655443322",
          "key": "email",
          "updated_at": "2024-04-01T12:00:00Z",
          "value": "jane.doe@example.com",
          "definition": {
            "created_at": "2023-11-20T08:00:00Z",
            "entity_type": "user",
            "id": "key_1122334455667788",
            "key": "email",
            "updated_at": "2024-04-01T12:00:00Z"
          }
        }
      ],
      "name": "Jane Doe",
      "updated_at": "2024-04-01T12:00:00Z",
      "last_seen_at": "2024-04-10T16:20:00Z",
      "traits": {
        "role": "Product Manager",
        "location": "New York"
      }
    }
  ],
  "params": {
    "company_id": "comp_1234567890abcdef",
    "ids": [
      "user_9876543210fedcba",
      "user_1234567890abcdef"
    ],
    "limit": 100,
    "offset": 0,
    "plan_id": "plan_premium_2024",
    "q": "Jane"
  }
}

Authentication

X-Schematic-Api-Keystring

API Key authentication via header

Query parameters

company_idstringOptional

Filter users by company ID (starts with comp_)

idslist of stringsOptional

Filter users by multiple user IDs (starts with user_)

plan_idstringOptional

Filter users by plan ID (starts with plan_)

qstringOptional<=512 characters

Search for users by name, keys or string traits

limitintegerOptional

Page limit (default 100)

offsetintegerOptional

Page offset (default 0)

Response

datalist of objects

paramsobject

Input parameters

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

500

Internal Server Error