Lookup user | SchematicHQ

1 import { SchematicClient } from "@schematichq/schematic-typescript-node"; 2 3 const client = new SchematicClient({ apiKey: "YOUR_API_KEY" }); 4 await client.companies.lookupUser({ 5 keys: { 6 "keys": "keys" 7 } 8 });

1 { 2 "data": { 3 "company_memberships": [ 4 { 5 "company_id": "string", 6 "created_at": "2024-01-15T09:30:00Z", 7 "id": "string", 8 "updated_at": "2024-01-15T09:30:00Z", 9 "user_id": "string", 10 "company": { 11 "created_at": "2024-01-15T09:30:00Z", 12 "environment_id": "string", 13 "id": "string", 14 "name": "string", 15 "updated_at": "2024-01-15T09:30:00Z", 16 "last_seen_at": "2024-01-15T09:30:00Z", 17 "logo_url": "string" 18 } 19 } 20 ], 21 "created_at": "2024-01-15T09:30:00Z", 22 "entity_traits": [ 23 { 24 "created_at": "2024-01-15T09:30:00Z", 25 "definition_id": "string", 26 "environment_id": "string", 27 "id": "string", 28 "updated_at": "2024-01-15T09:30:00Z", 29 "value": "string", 30 "definition": { 31 "created_at": "2024-01-15T09:30:00Z", 32 "display_name": "string", 33 "entity_type": "string", 34 "hierarchy": [ 35 "string" 36 ], 37 "id": "string", 38 "trait_type": "string", 39 "updated_at": "2024-01-15T09:30:00Z" 40 } 41 } 42 ], 43 "environment_id": "string", 44 "id": "string", 45 "keys": [ 46 { 47 "created_at": "2024-01-15T09:30:00Z", 48 "definition_id": "string", 49 "entity_id": "string", 50 "entity_type": "string", 51 "environment_id": "string", 52 "id": "string", 53 "key": "string", 54 "updated_at": "2024-01-15T09:30:00Z", 55 "value": "string", 56 "definition": { 57 "created_at": "2024-01-15T09:30:00Z", 58 "entity_type": "string", 59 "id": "string", 60 "key": "string", 61 "updated_at": "2024-01-15T09:30:00Z" 62 } 63 } 64 ], 65 "name": "string", 66 "updated_at": "2024-01-15T09:30:00Z", 67 "last_seen_at": "2024-01-15T09:30:00Z", 68 "traits": {} 69 }, 70 "params": { 71 "keys": {} 72 } 73 }

Authentication

X-Schematic-Api-Keystring

API Key authentication via header

Query parameters

keysmap from strings to stringsRequired

Key/value pairs

Response

dataobject

paramsobject

Input parameters

Authentication

Query parameters

Response

Errors