Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Kin Lane

Chat with Kin

AI assistant · trained on my blog

Netter

Netter companies API

The companies API from Netter — 10 operation(s) for companies.

Documentation Provider Profile APIs.io OpenAPI GitHub

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

Tagged areas include companies. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 13 operations across 10 paths, and defines 13 schemas. It is described by OpenAPI 3.1.0, at version 0.1.0.

Requests are made against the base URL https://api.netter.ai.

13 operations 10 paths 13 schemas 2 DELETE5 GET2 PATCH4 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
0.1.0
Base URL
https://api.netter.ai
Resource Areas
1

Paths & Operations 13

Across 10 paths, the API surfaces 13 operations — 2 DELETE, 5 GET, 2 PATCH, 4 POST. Each is listed below with its method, path, parameters, and response codes.

companies 13
GET
/api/v1/companies
List My Companies
list_my_companies_api_v1_companies_get → 200
POST
/api/v1/companies
Create Company
create_company_api_v1_companies_post body → 201422
POST
/api/v1/companies/accept-invitation
Accept Invitation
accept_invitation_api_v1_companies_accept_invitation_post body → 201422
GET
/api/v1/companies/invitations/validate
Validate Invitation
validate_invitation_api_v1_companies_invitations_validate_get 1 param → 200422
POST
/api/v1/companies/{company_id}/switch
Switch Default Company
switch_default_company_api_v1_companies__company_id__switch_post 1 param → 200422
GET
/api/v1/companies/{company_id}
Get Company
get_company_api_v1_companies__company_id__get 1 param → 200422
PATCH
/api/v1/companies/{company_id}
Update Company
update_company_api_v1_companies__company_id__patch 1 param body → 200422
POST
/api/v1/companies/{company_id}/invite
Invite Member
invite_member_api_v1_companies__company_id__invite_post 1 param body → 201422
DELETE
/api/v1/companies/{company_id}/members/{member_user_id}
Remove Member
remove_member_api_v1_companies__company_id__members__member_user_id__delete 2 params → 200422
PATCH
/api/v1/companies/{company_id}/members/{member_user_id}
Update Member Role
update_member_role_api_v1_companies__company_id__members__member_user_id__patch 2 params body → 200422
GET
/api/v1/companies/{company_id}/members
List Members
list_members_api_v1_companies__company_id__members_get 1 param → 200422
GET
/api/v1/companies/{company_id}/invitations
List Invitations
list_invitations_api_v1_companies__company_id__invitations_get 1 param → 200422
DELETE
/api/v1/companies/{company_id}/invitations/{invitation_id}
Cancel Invitation
cancel_invitation_api_v1_companies__company_id__invitations__invitation_id__delete 2 params → 200422

Schemas 13

The contract defines 13 schemas that model the data the API accepts and returns. The most detailed are CompanyInvitationRead (7 properties), ValidationError (5 properties), CompanyMemberRead (5 properties), CompanyRead (4 properties). Each schema is shown below with its type and property counts.

CompanyInvite
object
2 properties 1 required
ValidationError
object
5 properties 3 required
CompanyInvitationRead
object
7 properties 7 required
CompanyMemberSummary
object
Lightweight member view — no auth.users join. Used by :class:AcceptInvitation to report the newly-inserted member without reaching into auth.users for the emai…
4 properties 4 required
HTTPValidationError
object
1 property
CompanyMemberRead
object
5 properties 5 required
CompanyRead
object
4 properties 4 required
InvitationAccept
object
1 property 1 required
CompanyCreate
object
1 property 1 required
CompanyMemberRoleUpdate
object
Request body for changing an existing member's role (owner-only).
1 property 1 required
CompanyInvitationValidateRead
object
Public view of a pending invitation, resolved by token. Returned by the unauthenticated /invitations/validate endpoint so the accept page can show who the invi…
3 properties 3 required
CompanyListResponse
object
2 properties 2 required
CompanyUpdate
object
1 property

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

netter-companies-api-openapi.yml Raw ↑

Other APIs Netter publishes across the network.

Netter actions API
AE Profile APIs.io
Netter api-keys API
AE Profile APIs.io
Netter app-chat API
AE Profile APIs.io
Netter apps API
AE Profile APIs.io
Netter apps-query API
AE Profile APIs.io
Netter assistant API
AE Profile APIs.io
Netter attributes API
AE Profile APIs.io
Netter automations API
AE Profile APIs.io
Netter chats API
AE Profile APIs.io
Netter dashboard-chat API
AE Profile APIs.io
Netter dashboard-data API
AE Profile APIs.io
Netter dashboard-versions API
AE Profile APIs.io
#companies
← Back to N APIs
API Details
ID
netter:netter-companies-api
Base URL
https://api.netter.ai
Docs
https://netter.ai/docs/api/overview.md
Provider
Netter
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network