How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Schematic

Schematic companies API

The companies API from Schematic — 29 operation(s) for companies.

Documentation Provider Profile APIs.io OpenAPI GitHub

Schematic companies API is one of 20 APIs that Schematic publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

This API exposes 4 JSON Schema definitions.

Tagged areas include Companies. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, authentication docs, a getting-started guide, a GitHub repository, and 4 JSON Schemas.

This API exposes 36 operations across 29 paths, and defines 85 schemas. It is described by OpenAPI 3.2.0, at version 0.1.

Requests are made against a single base URL, https://api.schematichq.com.

36 operations 29 paths 85 schemas 3 DELETE21 GET11 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
0.1
Server
https://api.schematichq.com
Authentication
API Key
Resource Areas
1

Authentication & Security 1

Schematic companies API declares 1 security scheme for authenticating requests. An API key is passed in the header as X-Schematic-Api-Key (ApiKeyAuth). By default, every request must be authenticated.

Paths & Operations 36

Across 29 paths, the API surfaces 36 operations — 3 DELETE, 21 GET, 11 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

companies 36
GET
/companies
List companies
listCompanies 19 params → 200400401403404500
POST
/companies
Upsert company
upsertCompany body → 200400401403404500
GET
/companies/{company_id}
Get company
getCompany 1 param → 200401403404500
DELETE
/companies/{company_id}
Delete company
deleteCompany 3 params → 200400401403404500
GET
/companies/count
Count companies
countCompanies 19 params → 200400401403404500
POST
/companies/create
Create company
createCompany body → 201400401403404500
POST
/companies/delete
Delete company by keys
deleteCompanyByKeys body → 200400401403404500
GET
/companies/lookup
Lookup company
lookupCompany 1 param → 200401403404500
GET
/company-memberships
List company memberships
listCompanyMemberships 4 params → 200400401403404500
POST
/company-memberships
Get or create company membership
getOrCreateCompanyMembership body → 200400401403404500
DELETE
/company-memberships/{company_membership_id}
Delete company membership
deleteCompanyMembership 1 param → 200400401403404500
GET
/company-subscriptions
Get active company subscription
getActiveCompanySubscription 4 params → 200400401403404500
POST
/company-traits
Upsert company trait
upsertCompanyTrait body → 200400401403404500
GET
/entity-key-definitions
List entity key definitions
listEntityKeyDefinitions 5 params → 200400401403404500
GET
/entity-key-definitions/count
Count entity key definitions
countEntityKeyDefinitions 5 params → 200400401403404500
GET
/entity-trait-definitions
List entity trait definitions
listEntityTraitDefinitions 7 params → 200400401403404500
POST
/entity-trait-definitions
Get or create entity trait definition
getOrCreateEntityTraitDefinition body → 200400401403404500
GET
/entity-trait-definitions/{entity_trait_definition_id}
Get entity trait definition
getEntityTraitDefinition 1 param → 200401403404500
PUT
/entity-trait-definitions/{entity_trait_definition_id}
Update entity trait definition
updateEntityTraitDefinition 1 param body → 200400401403404500
GET
/entity-trait-definitions/count
Count entity trait definitions
countEntityTraitDefinitions 7 params → 200400401403404500
GET
/entity-trait-values
Get entity trait values
getEntityTraitValues 4 params → 200400401403404500
GET
/plan-changes
List plan changes
listPlanChanges 7 params → 200400401403404500
GET
/plan-changes/{plan_change_id}
Get plan change
getPlanChange 1 param → 200401403404500
GET
/plan-traits
List plan traits
listPlanTraits 6 params → 200400401403404500
GET
/plan-traits/{plan_trait_id}
Get plan trait
getPlanTrait 1 param → 200401403404500
POST
/plan-traits/bulk
Update plan traits bulk
updatePlanTraitsBulk body → 200400401403404500
GET
/plan-traits/count
Count plan traits
countPlanTraits 6 params → 200400401403404500
POST
/user-traits
Upsert user trait
upsertUserTrait body → 200400401403404500
GET
/users
List users
listUsers 6 params → 200400401403404500
POST
/users
Upsert user
upsertUser body → 200400401403404500
GET
/users/{user_id}
Get user
getUser 1 param → 200401403404500
DELETE
/users/{user_id}
Delete user
deleteUser 1 param → 200400401403404500
GET
/users/count
Count users
countUsers 6 params → 200400401403404500
POST
/users/create
Create user
createUser body → 201400401403404500
POST
/users/delete
Delete user by keys
deleteUserByKeys body → 200400401403404500
GET
/users/lookup
Lookup user
lookupUser 1 param → 200401403404500

Schemas 85

The contract defines 85 schemas that model the data the API accepts and returns. The most detailed are PlanCreditGrantView (28 properties), BillingSubscriptionView (24 properties), CompanyDetailResponseData (24 properties), BillingPriceView (23 properties). Each schema is shown below with its type and property counts.

CompanyMembershipDetailResponseData
object
6 properties 5 required
CompanyDetailResponseData
object
24 properties 16 required
Rule
object
10 properties 9 required
KeysRequestBody
object
1 property 1 required
CustomPlanBillingResponseData
object
11 properties 8 required
DeleteResponse
object
1 property
SubscriptionStatus
string
CreditCurrencyPrice
object
2 properties 1 required
SubscriptionTraitUpdate
object
7 properties 7 required
EnvironmentResponseData
object
5 properties 5 required
UserResponseData
object
6 properties 5 required
MetricPeriodMonthReset
string
CustomPlanActivationStrategy
string
BillingPriceView
object
23 properties 17 required
BillingCreditRolloverPolicy
string
PlanTraitResponseData
object
9 properties 9 required
BillingSubscriptionView
object
24 properties 14 required
SubscriptionType
string
CustomPlanBillingStatus
string
EntityTraitDefinitionResponseData
object
7 properties 7 required
CreateEntityTraitDefinitionRequestBody
object
4 properties 3 required
ComparableOperator
string
PlanChangeBasePlanAction
string
PlanCreditGrantView
object
28 properties 10 required
BillingPlanCreditGrantResetStart
string
AuditLogListResponseData
object
16 properties 5 required
UpdateEntityTraitDefinitionRequestBody
object
2 properties 1 required
GetOrCreateCompanyMembershipRequestBody
object
2 properties 2 required
SortDirection
string
EntityKeyDetailResponseData
object
10 properties 9 required
PlanChangeAction
string
ScheduledDowngradeResponseData
object
11 properties 9 required
UpdatePlanTraitTraitRequestBody
object
2 properties 2 required
TraitType
string
EntityType
string
PlanVersionSnapshotView
object
3 properties 3 required
ApiKeyResponseData
object
10 properties 6 required
CountResponse
object
1 property
BillingPlanCreditGrantResetCadence
string
BillingProductPriceTierResponseData
object
4 properties
ApiError
object
1 property 1 required
EntitlementValueType
string
PaymentMethodResponseData
object
18 properties 8 required
BillingPriceScheme
string
CompanyResponseData
object
7 properties 5 required
RuleType
string
ConditionGroup
object
1 property 1 required
BillingProductResponseData
object
13 properties 11 required
PlanChangeResponseData
object
22 properties 10 required
PlanSnapshotView
object
5 properties 5 required
CompanyEventPeriodMetricsResponseData
object
11 properties 10 required
BillingPriceUsageType
string
InvoiceResponseData
object
19 properties 12 required
EntityKeyDefinitionResponseData
object
5 properties 5 required
UserDetailResponseData
object
10 properties 8 required
PlanChangeSubscriptionAction
string
BillingProductForSubscriptionResponseData
object
22 properties 18 required
BillingPlanCreditGrantResetType
string
UpdatePlanTraitBulkRequestBody
object
3 properties 3 required
BillingProviderType
string
BillingTiersMode
string
BillingCreditBurnStrategy
string
EnvironmentType
string
GenericPreviewObject
object
4 properties 2 required
BillingCreditExpiryUnit
string
BillingCreditView
object
20 properties 12 required
Condition
object
15 properties 7 required
UpsertCompanyRequestBody
object
7 properties 1 required
UpsertUserRequestBody
object
10 properties 1 required
ApiKeyScope
string
BillingSubscriptionTrialEndSetting
string
TraitDefinition
object
3 properties 3 required
CompanyPlanWithBillingSubView
object
11 properties 3 required
ActorType
string
CompanySubscriptionResponseData
object
15 properties 10 required
ConditionType
string
UpsertTraitRequestBody
object
5 properties 2 required
BillingSubscriptionDiscountView
object
14 properties 7 required
MetricPeriod
string
InvoiceStatus
string
FeatureEntitlement
object
14 properties 3 required
EntityTraitValue
object
2 properties 2 required
BillingProductPriceInterval
string
EntityTraitDetailResponseData
object
7 properties 6 required
BillingCreditExpiryType
string

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

schematic-companies-api-openapi.yml Raw ↑

Other APIs Schematic publishes across the network.

Schematic accesstokens API
AE Profile APIs.io
Schematic accounts API
AE Profile APIs.io
Schematic billing API
AE Profile APIs.io
Schematic checkout API
AE Profile APIs.io
Schematic components API
AE Profile APIs.io
Schematic componentspublic API
AE Profile APIs.io
Schematic credits API
AE Profile APIs.io
Schematic dataexports API
AE Profile APIs.io
Schematic entitlements API
AE Profile APIs.io
Schematic events API
AE Profile APIs.io
Schematic features API
AE Profile APIs.io
Schematic insights API
AE Profile APIs.io
#Companies
← Back to S APIs
API Details
ID
schematic:schematic-companies-api
Server
https://api.schematichq.com
Docs
https://schematichq.com/
Provider
Schematic
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=schematic-companies-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/schematic-companies-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have. Your account

Where this information came from

This is an independent, third-party profile of Schematic companies API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.