Airbyte

Airbyte Public Groups API

The public_groups API from Airbyte — 2 operation(s) for public_groups.

GitHub OpenAPI

Operations 5

Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay

GET /groups List groups in an organization · Airbyte List Groups #
Ask an LLM
“What user groups exist in my organization?”
“How do I list all the groups for an organization?”
Tell an agent
List the groups in organization {organizationId}.
Show the first {limit} groups in organization {organizationId}.
POST /groups Create a user group · Airbyte Create Group #
Ask an LLM
“How do I create a group to manage access for a team?”
“Can I add a description when creating a group?”
Tell an agent
Create a group named {name} in organization {organizationId}.
Create group {name} in organization {organizationId} described as {description}.
GET /groups/{groupId} Get a group's details · Airbyte Get Group Details #
Ask an LLM
“How do I look up one group by its id?”
“What name and description does a group have?”
Tell an agent
Get group {groupId}.
Show the details of group {groupId}.
PATCH /groups/{groupId} Rename or redescribe a group · Airbyte Update Group #
Ask an LLM
“How do I rename an existing group?”
“Can I change a group's description?”
Tell an agent
Rename group {groupId} to {name}.
Change the description of group {groupId} to {description}.
DELETE /groups/{groupId} Delete a group · Airbyte Delete Group #
Ask an LLM
“How do I delete a group entirely?”
“Does deleting a group remove all of its memberships?”
Tell an agent destructive · confirm first
Delete group {groupId}.
Delete group {groupId} along with all its memberships.

Documentation

📖
Documentation
https://docs.airbyte.com
📖
APIReference
https://reference.airbyte.com/reference/getting-started
📖
Authentication
https://docs.airbyte.com/api-documentation

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/airbyte/refs/heads/main/openapi/airbyte-public-groups-api-openapi.yml

Other Resources

🔗
SDKs
https://github.com/airbytehq/airbyte-api-python-sdk
🔗
SDKs
https://github.com/airbytehq/airbyte-api-java-sdk
🔗
SDKs
https://pypi.org/project/airbyte-api/
🔗
SDKs
https://github.com/airbytehq/terraform-provider-airbyte
🔗
GraphQL
https://raw.githubusercontent.com/api-evangelist/airbyte/refs/heads/main/graphql/airbyte-graphql.md

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/airbyte:airbyte-public-groups-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

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.

GitHub Google LinkedIn

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

OpenAPI Specification

airbyte-public-groups-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: airbyte-api Public Groups API
  version: 1.0.0
  description: Programmatically control Airbyte Cloud, OSS & Enterprise.
servers:
- url: https://api.airbyte.com/v1
  description: Airbyte API v1
tags:
- name: public_groups
paths:
  /groups:
    get:
      tags:
      - public_groups
      summary: Airbyte List Groups
      description: List all groups within the specified organization
      parameters:
      - name: organizationId
        in: query
        description: Filter groups by organization ID
        required: true
        schema:
          type: string
          format: uuid
      - name: limit
        description: Set the limit on the number of Groups returned. The default is 20 Groups.
        schema:
          format: int32
          default: 20
          maximum: 100
          minimum: 1
          type: integer
        in: query
      - name: offset
        description: Set the offset to start at when returning Groups. The default is 0.
        schema:
          format: int32
          default: 0
          minimum: 0
          type: integer
        in: query
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GroupsResponse'
              examples:
                listGroups200Example:
                  summary: Default listGroups 200 response
                  x-microcks-default: true
                  value:
                    data: example
                    next: example
                    previous: example
          description: List Groups.
        '403':
          description: Not allowed
        '404':
          description: Not found
      operationId: listGroups
      x-speakeasy-alias: listGroups
      x-speakeasy-group: Groups
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    post:
      tags:
      - public_groups
      summary: Airbyte Create Group
      description: Create a new group within an organization
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GroupCreateRequest'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GroupResponse'
              examples:
                createGroup200Example:
                  summary: Default createGroup 200 response
                  x-microcks-default: true
                  value:
                    groupId: abc123
                    name: example-name
                    description: Example description
                    organizationId: abc123
                    memberCount: 1
          description: Group created successfully.
        '400':
          description: Invalid input
        '403':
          description: Not allowed
        '409':
          description: Group with this name already exists in the organization
      operationId: createGroup
      x-speakeasy-alias: createGroup
      x-speakeasy-group: Groups
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /groups/{groupId}:
    parameters:
    - name: groupId
      in: path
      required: true
      description: Group identifier
      schema:
        type: string
        format: uuid
    get:
      tags:
      - public_groups
      summary: Airbyte Get Group Details
      description: Get a specific group by ID
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GroupResponse'
              examples:
                getGroup200Example:
                  summary: Default getGroup 200 response
                  x-microcks-default: true
                  value:
                    groupId: abc123
                    name: example-name
                    description: Example description
                    organizationId: abc123
                    memberCount: 1
          description: Get a Group by the id in the path.
        '403':
          description: Not allowed
        '404':
          description: Not found
      operationId: getGroup
      x-speakeasy-alias: getGroup
      x-speakeasy-group: Groups
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    patch:
      tags:
      - public_groups
      summary: Airbyte Update Group
      description: Update an existing group
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GroupUpdateRequest'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GroupResponse'
              examples:
                updateGroup200Example:
                  summary: Default updateGroup 200 response
                  x-microcks-default: true
                  value:
                    groupId: abc123
                    name: example-name
                    description: Example description
                    organizationId: abc123
                    memberCount: 1
          description: Group updated successfully.
        '400':
          description: Invalid input
        '403':
          description: Not allowed
        '404':
          description: Not found
        '409':
          description: Group name conflict
      operationId: updateGroup
      x-speakeasy-alias: updateGroup
      x-speakeasy-group: Groups
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    delete:
      tags:
      - public_groups
      summary: Airbyte Delete Group
      description: Delete a group and remove all associated memberships
      responses:
        '204':
          description: Group deleted successfully
        '403':
          description: Not allowed
        '404':
          description: Not found
      operationId: deleteGroup
      x-speakeasy-alias: deleteGroup
      x-speakeasy-group: Groups
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
components:
  schemas:
    GroupUpdateRequest:
      title: Root Type for GroupUpdateRequest
      description: Request body for updating a group
      type: object
      properties:
        name:
          type: string
          description: The updated name of the group
        description:
          type: string
          nullable: true
          description: The updated description of the group
      x-speakeasy-component: true
      x-speakeasy-entity: Group
      x-speakeasy-param-suppress-computed-diff: true
    GroupsResponse:
      title: Root Type for GroupsResponse
      description: List/Array of multiple groups
      required:
      - data
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/GroupResponse'
        next:
          type: string
          description: Link to the next page of results
          nullable: true
        previous:
          type: string
          description: Link to the previous page of results
          nullable: true
      x-speakeasy-component: true
      x-speakeasy-entity: Group
      x-speakeasy-param-suppress-computed-diff: true
    GroupCreateRequest:
      title: Root Type for GroupCreateRequest
      description: Request body for creating a group
      required:
      - name
      - organizationId
      type: object
      properties:
        name:
          type: string
          description: The name of the group
        description:
          type: string
          nullable: true
          description: Optional description of the group
        organizationId:
          type: string
          format: uuid
          description: The ID of the organization the group belongs to
      x-speakeasy-component: true
      x-speakeasy-entity: Group
      x-speakeasy-param-suppress-computed-diff: true
    GroupResponse:
      title: Root Type for GroupResponse
      description: Provides details of a single group
      type: object
      required:
      - groupId
      - name
      - organizationId
      - memberCount
      properties:
        groupId:
          type: string
          format: uuid
          description: The ID of the group
        name:
          type: string
          description: The name of the group
        description:
          type: string
          nullable: true
          description: Optional description of the group
        organizationId:
          type: string
          format: uuid
          description: The ID of the organization the group belongs to
        memberCount:
          type: integer
          format: int64
          description: The number of members in the group
      x-speakeasy-component: true
      x-speakeasy-entity: Group
      x-speakeasy-param-suppress-computed-diff: true