Altimate AI COMPANY API

The COMPANY API from Altimate AI — 6 operation(s) for company.

GitHub OpenAPI
Business capability
Tenant Provisioning & Lifecycle BC-4230.10

Operations 10

GET /companies/ Company Get All #
POST /companies/ Company Add #
GET /companies/{company_uuid} Company Get One #
PATCH /companies/{company_uuid} Company Edit #
DELETE /companies/{company_uuid} Company Delete #
GET /companies/available/{company} Company Available #
POST /companies/register Company Register #
POST /companies/register-social Company Register Social #
POST /companies/verify-user Company Verify User #
GET /companies/get-all-companies/{email} Get All Companies By Email #

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API
curl "https://apis.io/api/v1/apis/altimate-ai:altimate-ai-company-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

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

OpenAPI Specification

altimate-ai-company-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Fast COMPANY API
  version: 0.1.0
tags:
- name: Company
paths:
  /companies/:
    get:
      tags:
      - Company
      summary: Company Get All
      description: Get all companies. This operation is allowed only in the root domain.
      operationId: company_get_all_companies__get
      security:
      - HTTPBearer: []
      - HTTPBearer: []
      parameters:
      - name: search
        in: query
        required: false
        schema:
          type: string
          title: Search
      - name: sortOrder
        in: query
        required: false
        schema:
          type: string
          default: asc
          title: Sortorder
      - name: sortColumn
        in: query
        required: false
        schema:
          type: string
          default: name
          title: Sortcolumn
      - name: page
        in: query
        required: false
        schema:
          type: integer
          minimum: 1
          description: Page number
          default: 1
          title: Page
        description: Page number
      - name: size
        in: query
        required: false
        schema:
          type: integer
          maximum: 100
          minimum: 1
          description: Page size
          default: 50
          title: Size
        description: Page size
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Page_CompanyIndexResponse_'
        '400':
          description: Not supported for public user
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
                title: Response 400 Company Get All Companies  Get
        '403':
          description: Not supported for public user
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
                title: Response 403 Company Get All Companies  Get
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
    post:
      tags:
      - Company
      summary: Company Add
      description: Add a company. This operation is allowed only in the root domain.
      operationId: company_add_companies__post
      security:
      - HTTPBearer: []
      - HTTPBearer: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CompanyCreateIn'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CompanyIndexResponse'
        '403':
          description: This operation is forbidden in the tenant domain.
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
                title: Response 403 Company Add Companies  Post
        '400':
          description: Bad request.
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
                title: Response 400 Company Add Companies  Post
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /companies/{company_uuid}:
    get:
      tags:
      - Company
      summary: Company Get One
      description: Get a company. This operation is allowed only in the root domain.
      operationId: company_get_one_companies__company_uuid__get
      security:
      - HTTPBearer: []
      - HTTPBearer: []
      parameters:
      - name: company_uuid
        in: path
        required: true
        schema:
          type: string
          format: uuid
          title: Company Uuid
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CompanyIndexResponse'
        '400':
          description: Not supported for public user
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
                title: Response 400 Company Get One Companies  Company Uuid  Get
        '403':
          description: Not supported for public user
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
                title: Response 403 Company Get One Companies  Company Uuid  Get
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
    patch:
      tags:
      - Company
      summary: Company Edit
      description: Edit a company. This operation is allowed only in the root domain.
      operationId: company_edit_companies__company_uuid__patch
      deprecated: true
      security:
      - HTTPBearer: []
      - HTTPBearer: []
      parameters:
      - name: company_uuid
        in: path
        required: true
        schema:
          type: string
          format: uuid
          title: Company Uuid
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CompanyEditIn'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StandardResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
    delete:
      tags:
      - Company
      summary: Company Delete
      description: Delete a company. This operation is allowed only in the root domain.
      operationId: company_delete_companies__company_uuid__delete
      deprecated: true
      security:
      - HTTPBearer: []
      - HTTPBearer: []
      parameters:
      - name: company_uuid
        in: path
        required: true
        schema:
          type: string
          format: uuid
          title: Company Uuid
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StandardResponse'
        '400':
          description: Not supported for public user
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
                title: Response 400 Company Delete Companies  Company Uuid  Delete
        '403':
          description: Not supported for public user
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
                title: Response 403 Company Delete Companies  Company Uuid  Delete
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /companies/available/{company}:
    get:
      tags:
      - Company
      summary: Company Available
      operationId: company_available_companies_available__company__get
      security:
      - HTTPBearer: []
      parameters:
      - name: company
        in: path
        required: true
        schema:
          type: string
          title: Company
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StandardResponse'
        '403':
          description: This operation is forbidden in the tenant domain.
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
                title: Response 403 Company Available Companies Available  Company  Get
        '400':
          description: Bad request.
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
                title: Response 400 Company Available Companies Available  Company  Get
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /companies/register:
    post:
      tags:
      - Company
      summary: Company Register
      operationId: company_register_companies_register_post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CompanyRegister'
        required: true
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StandardResponse'
        '403':
          description: This operation is forbidden in the tenant domain.
          content:
            application/json:
              schema:
                additionalProperties: true
                type: object
                title: Response 403 Company Register Companies Register Post
        '400':
          description: Bad request.
          content:
            application/json:
              schema:
                additionalProperties: true
                type: object
                title: Response 400 Company Register Companies Register Post
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
      - HTTPBearer: []
  /companies/register-social:
    post:
      tags:
      - Company
      summary: Company Register Social
      description: 'Provision a new tenant for a socially-authenticated (Google) user.


        Runs on the public tenant against a verified SuperTokens session — the user

        has already completed Google OAuth and passed the Workspace `hd` gate in the

        sign-in-up hook. Email comes from the session (never from the client); only

        the instance name (and optional display name) come from the request.

        Creates the tenant + Owner + billing + community credits and returns the

        gateway credential. If the instance name is taken, returns

        ``status="instance_taken"`` so the UI can re-prompt.'
      operationId: company_register_social_companies_register_social_post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SocialRegisterIn'
        required: true
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SocialRegisterResponse'
        '403':
          description: Forbidden in the tenant domain.
          content:
            application/json:
              schema:
                additionalProperties: true
                type: object
                title: Response 403 Company Register Social Companies Register Social Post
        '400':
          description: Bad request.
          content:
            application/json:
              schema:
                additionalProperties: true
                type: object
                title: Response 400 Company Register Social Companies Register Social Post
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
      - HTTPBearer: []
  /companies/verify-user:
    post:
      tags:
      - Company
      summary: Company Verify User
      operationId: company_verify_user_companies_verify_user_post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/InviteVerifyIn'
        required: true
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StandardResponse'
        '403':
          description: This operation is forbidden in the tenant domain.
          content:
            application/json:
              schema:
                additionalProperties: true
                type: object
                title: Response 403 Company Verify User Companies Verify User Post
        '400':
          description: Bad request.
          content:
            application/json:
              schema:
                additionalProperties: true
                type: object
                title: Response 400 Company Verify User Companies Verify User Post
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
      - HTTPBearer: []
  /companies/get-all-companies/{email}:
    get:
      tags:
      - Company
      summary: Get All Companies By Email
      operationId: get_all_companies_by_email_companies_get_all_companies__email__get
      security:
      - HTTPBearer: []
      parameters:
      - name: email
        in: path
        required: true
        schema:
          type: string
          title: Email
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetAllCompaniesResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
components:
  schemas:
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    CompanyRegister:
      properties:
        company:
          type: string
          title: Company
        name:
          type: string
          title: Name
        email:
          type: string
          format: email
          title: Email
        password:
          type: string
          title: Password
        newsletter:
          type: boolean
          title: Newsletter
        source_insight:
          anyOf:
          - type: string
          - type: 'null'
          title: Source Insight
        referral_code:
          anyOf:
          - type: string
          - type: 'null'
          title: Referral Code
        survey_responses:
          anyOf:
          - additionalProperties: true
            type: object
          - type: 'null'
          title: Survey Responses
        primary_warehouse:
          anyOf:
          - type: string
          - type: 'null'
          title: Primary Warehouse
        role:
          anyOf:
          - type: string
          - type: 'null'
          title: Role
      type: object
      required:
      - company
      - name
      - email
      - password
      - newsletter
      title: CompanyRegister
    GetCompanyByEmailResponse:
      properties:
        company:
          anyOf:
          - $ref: '#/components/schemas/CompanyIndexResponse'
          - type: 'null'
        company_url:
          anyOf:
          - type: string
          - type: 'null'
          title: Company Url
      type: object
      title: GetCompanyByEmailResponse
    StandardResponse:
      properties:
        ok:
          type: boolean
          title: Ok
      type: object
      required:
      - ok
      title: StandardResponse
    CompanyIndexResponse:
      properties:
        name:
          anyOf:
          - type: string
          - type: 'null'
          title: Name
        country:
          anyOf:
          - type: string
          - type: 'null'
          title: Country
        uuid:
          type: string
          format: uuid
          title: Uuid
        provider:
          anyOf:
          - type: string
          - type: 'null'
          title: Provider
        created_at:
          anyOf:
          - type: string
            format: date-time
          - type: 'null'
          title: Created At
        existence_time:
          anyOf:
          - type: string
          - type: 'null'
          title: Existence Time
      type: object
      required:
      - uuid
      title: CompanyIndexResponse
    GetAllCompaniesResponse:
      properties:
        companies:
          items:
            $ref: '#/components/schemas/GetCompanyByEmailResponse'
          type: array
          title: Companies
          default: []
      type: object
      title: GetAllCompaniesResponse
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
            - type: string
            - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
      type: object
      required:
      - loc
      - msg
      - type
      title: ValidationError
    Page_CompanyIndexResponse_:
      properties:
        items:
          items:
            $ref: '#/components/schemas/CompanyIndexResponse'
          type: array
          title: Items
        total:
          anyOf:
          - type: integer
            minimum: 0.0
          - type: 'null'
          title: Total
        page:
          anyOf:
          - type: integer
            minimum: 1.0
          - type: 'null'
          title: Page
        size:
          anyOf:
          - type: integer
            minimum: 1.0
          - type: 'null'
          title: Size
        pages:
          anyOf:
          - type: integer
            minimum: 0.0
          - type: 'null'
          title: Pages
      type: object
      required:
      - items
      - total
      - page
      - size
      title: Page[CompanyIndexResponse]
    SocialRegisterResponse:
      properties:
        status:
          type: string
          enum:
          - ok
          - instance_taken
          title: Status
        instance:
          anyOf:
          - type: string
          - type: 'null'
          title: Instance
        api_url:
          anyOf:
          - type: string
          - type: 'null'
          title: Api Url
        login_token:
          anyOf:
          - type: string
          - type: 'null'
          title: Login Token
      type: object
      required:
      - status
      title: SocialRegisterResponse
      description: 'Result of provisioning a tenant for a social (OAuth) signup.


        On success, carries a short-lived ``login_token`` the client exchanges (via

        /auth/social/exchange) for the gateway credential — the raw api_key is never

        returned to the client. When the chosen instance name is taken (or belongs to

        an instance running its own IdP), ``status == "instance_taken"`` and the

        fields are null so the UI can re-prompt — the two negatives are intentionally

        indistinguishable so the response can''t enumerate SSO instances.'
    InviteVerifyIn:
      properties:
        token:
          type: string
          title: Token
      type: object
      required:
      - token
      title: InviteVerifyIn
    CompanyEditIn:
      properties:
        name:
          anyOf:
          - type: string
          - type: 'null'
          title: Name
        country:
          anyOf:
          - type: string
          - type: 'null'
          title: Country
      type: object
      title: CompanyEditIn
    SocialRegisterIn:
      properties:
        company:
          type: string
          title: Company
        newsletter:
          type: boolean
          title: Newsletter
          default: false
        first_name:
          anyOf:
          - type: string
          - type: 'null'
          title: First Name
        last_name:
          anyOf:
          - type: string
          - type: 'null'
          title: Last Name
        source_insight:
          anyOf:
          - type: string
          - type: 'null'
          title: Source Insight
        referral_code:
          anyOf:
          - type: string
          - type: 'null'
          title: Referral Code
        survey_responses:
          anyOf:
          - additionalProperties: true
            type: object
          - type: 'null'
          title: Survey Responses
        primary_warehouse:
          anyOf:
          - type: string
          - type: 'null'
          title: Primary Warehouse
        role:
          anyOf:
          - type: string
          - type: 'null'
          title: Role
      type: object
      required:
      - company
      title: SocialRegisterIn
      description: 'Provision a new tenant for a socially-authenticated (OAuth) user.


        Email is taken from the verified SuperTokens session; the client supplies

        the chosen instance name and, optionally, the display name read from the

        OAuth profile (falls back to the email local-part when absent).'
    CompanyCreateIn:
      properties:
        name:
          anyOf:
          - type: string
          - type: 'null'
          title: Name
        country:
          anyOf:
          - type: string
          - type: 'null'
          title: Country
        provider:
          type: string
          enum:
          - snowflake
          - databricks
          title: Provider
          default: snowflake
      type: object
      title: CompanyCreateIn
  securitySchemes:
    HTTPBearer:
      type: http
      scheme: bearer
x-provenance:
  method: harvested
  publisher: Altimate AI
  source: https://api.myaltimate.com/openapi.json
  note: split by refine-openapis from the provider's own published document, verified by fetch (openapi/_original/*.fetch.json);
    stamped by stamp-openapi-provenance.py (roadmap#793)