List company memberships

GET

https://api.schematichq.com/company-memberships

GET

/company-memberships

1 import { SchematicClient } from "@schematichq/schematic-typescript-node";
2 
3 const client = new SchematicClient({ apiKey: "YOUR_API_KEY" });
4 await client.companies.listCompanyMemberships({
5     companyId: "company_id",
6     userId: "user_id",
7     limit: 1,
8     offset: 1
9 });

Try it

1 {
2   "data": [
3     {
4       "company_id": "string",
5       "created_at": "2024-01-15T09:30:00Z",
6       "id": "string",
7       "updated_at": "2024-01-15T09:30:00Z",
8       "user_id": "string",
9       "company": {
10         "created_at": "2024-01-15T09:30:00Z",
11         "environment_id": "string",
12         "id": "string",
13         "name": "string",
14         "updated_at": "2024-01-15T09:30:00Z",
15         "last_seen_at": "2024-01-15T09:30:00Z",
16         "logo_url": "string"
17       }
18     }
19   ],
20   "params": {
21     "company_id": "string",
22     "limit": "100",
23     "offset": "0",
24     "user_id": "string"
25   }
26 }

Authentication

X-Schematic-Api-Keystring

API Key authentication via header

Query parameters

company_idstringOptional

user_idstringOptional

limitintegerOptional

Page limit (default 100)

offsetintegerOptional

Page offset (default 0)

Response

datalist of objects

paramsobject

Input parameters

Authentication

Query parameters

Response

Errors