Get or create company membership

import { SchematicClient } from "@schematichq/schematic-typescript-node";
async function main() {
    const client = new SchematicClient({
        apiKey: "YOUR_API_KEY_HERE",
    });
    await client.companies.getOrCreateCompanyMembership({
        companyId: "c9f1a2b3-4d5e-678f-9012-3456789abcde",
        userId: "u1234567-89ab-cdef-0123-456789abcdef",
    });
}
main();

{
  "data": {
    "company_id": "c9f1a2b3-4d5e-678f-9012-3456789abcde",
    "created_at": "2024-01-15T09:30:00Z",
    "id": "memb-7890abcd-1234-ef56-7890-abcdef123456",
    "updated_at": "2024-04-10T12:00:00Z",
    "user_id": "u1234567-89ab-cdef-0123-456789abcdef",
    "company": {
      "created_at": "2024-01-15T09:30:00Z",
      "environment_id": "env-prod-001",
      "id": "c9f1a2b3-4d5e-678f-9012-3456789abcde",
      "name": "Acme Corporation",
      "updated_at": "2024-04-10T12:00:00Z",
      "last_seen_at": "2024-04-20T16:45:00Z",
      "logo_url": "https://cdn.schematichq.com/logos/company_logo_123.png"
    }
  },
  "params": {}
}

Authentication

X-Schematic-Api-Keystring

API Key authentication via header

Request

This endpoint expects an object.

company_idstringRequired

user_idstringRequired

Response

dataobject

paramsobject

Input parameters

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

500

Internal Server Error