InternetData Organization API

openapi: 3.2.0
info:
  title: InternetData Organization API
  description: 'The InternetData API: download the databases your organization is licensed

    for, and manage the account behind them.


    See https://docs.internetdata.io for guides and https://github.com/internetdata

    for the official client libraries.'
  contact:
    name: InternetData Support
    email: support@internetdata.io
    url: https://internetdata.io
  termsOfService: https://internetdata.io/terms
  version: 2026.11.08
servers:
- url: https://internetdata.io
tags:
- name: Organization
  description: The organization it is scoped to.
  x-displayName: Organization
paths:
  /api/v1/iam/org:
    get:
      operationId: accountOrg
      tags:
      - Organization
      summary: Organization
      description: 'The organization this credential is scoped to.


        There is no way to name a different one. A credential describes exactly

        one organization, so an identifier in the path could only ever be your

        own or a refusal.'
      security:
      - BearerAuth:
        - org.read
      responses:
        '200':
          description: The organization.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccountOrgWrap'
        '401':
          $ref: '#/components/responses/AccountUnauthorized'
        '403':
          $ref: '#/components/responses/AccountForbidden'
  /api/v1/iam/org/members:
    get:
      operationId: accountOrgMembers
      tags:
      - Organization
      summary: Members
      description: 'Read-only. Adding or removing a member is an invitation flow with email

        in the middle rather than a POST, and modeling it as one here would

        promise something this API does not do.'
      security:
      - BearerAuth:
        - org.read
      responses:
        '200':
          description: The members.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccountRc'
        '401':
          $ref: '#/components/responses/AccountUnauthorized'
        '403':
          $ref: '#/components/responses/AccountForbidden'
components:
  responses:
    AccountUnauthorized:
      description: No credential was presented, or it is not valid.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/AccountRc'
    AccountForbidden:
      description: 'The credential does not hold the scope this endpoint requires. The

        missing scope is deliberately not named.

        '
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/AccountRc'
  schemas:
    AccountOrgWrap:
      type: object
      properties:
        rc:
          type: string
        org:
          $ref: '#/components/schemas/AccountOrg'
      required:
      - rc
      - org
    AccountRc:
      type: object
      properties:
        rc:
          type: string
          description: The outcome. `SUCCESS` on success; otherwise the reason.
      required:
      - rc
    AccountOrg:
      type: object
      properties:
        id:
          type: string
          format: uuid
        name:
          type: string
        created:
          type:
          - string
          - 'null'
          format: date-time
      required:
      - id
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: query
      name: apikey
      description: 'UUID-format API key issued to the customer. Each key is authorized for a

        specific set of database IDs; requesting any other ID returns 403.


        v1 only. The v2 endpoints take a console-issued key as a bearer token.

        '
    BearerAuth:
      type: http
      scheme: bearer
      description: '`Authorization: Bearer <key>`, with a key from the console. Keys are

        default-deny: each operation names the scope it needs, and an existing

        key does not gain an operation until that scope is added to it.

        '
    ApiKeyHeaderAuth:
      type: apiKey
      in: header
      name: X-Api-Key
      description: '`X-Api-Key: <key>`. The same v2 key, for clients that do not set a bearer.'
    ApiKeyQueryAuth:
      type: apiKey
      in: query
      name: apikey
      description: '`?apikey=<key>`. Convenient in a browser or a curl one-liner, which is

        how a database is usually fetched; prefer a header elsewhere.


        This is the same v2 key as the other two schemes. A v1 credential is a

        different vocabulary and fails validation here, as it would anywhere.

        '
x-tagGroups:
- name: InternetData Database API
  tags:
  - Database
  - Database v2
- name: InternetData IAM API
  tags:
  - Account
  - Organization
  - API keys
- name: InternetData Authorization
  tags:
  - Authorization