Recall.ai Google Login Group API

openapi: 3.2.0
info:
  title: Recall.ai Google Login Group API
  version: 0.0.0
  description: Recall.ai API Documentation
servers:
- url: https://us-east-1.recall.ai
  description: Recall.ai API
- url: https://eu-central-1.recall.ai
  description: European Recall.ai API
- url: https://ap-northeast-1.recall.ai
  description: Asia Recall.ai API
- url: https://us-west-2.recall.ai
  description: Pay-as-you-go Recall.ai API
tags:
- name: google-login-group
paths:
  /api/v2/google-login-groups/:
    get:
      operationId: google_login_groups_list
      description: 'Get list of all Google Login Groups.


        The base rate limit for this endpoint is:

        - 60 requests per min per workspace'
      summary: List Google Login Groups
      parameters:
      - name: cursor
        required: false
        in: query
        description: The pagination cursor value.
        schema:
          type: string
      - in: query
        name: name
        schema:
          type: string
      - in: query
        name: name__contains
        schema:
          type: string
      - name: ordering
        required: false
        in: query
        description: Which field to use when ordering the results.
        schema:
          type: string
      tags:
      - google-login-group
      security:
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaginatedGoogleLoginGroupList'
          description: ''
      x-throttles:
      - scope_key: workspace_id
        limit: 60
        period: min
    post:
      operationId: google_login_groups_create
      description: 'Create a new Google Login Group.


        The base rate limit for this endpoint is:

        - 300 requests per min per workspace'
      summary: Create Google Login Group
      tags:
      - google-login-group
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GoogleLoginGroupRequest'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/GoogleLoginGroupRequest'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/GoogleLoginGroupRequest'
        required: true
      security:
      - tokenAuth: []
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GoogleLoginGroup'
          description: ''
      x-throttles:
      - scope_key: workspace_id
        limit: 300
        period: min
  /api/v2/google-login-groups/{id}/:
    get:
      operationId: google_login_groups_retrieve
      description: 'Get an existing Google Login Group.


        The base rate limit for this endpoint is:

        - 300 requests per min per workspace'
      summary: Retrieve Google Login Group
      parameters:
      - in: path
        name: id
        schema:
          type: string
          format: uuid
        description: A UUID string identifying this google login group.
        required: true
      tags:
      - google-login-group
      security:
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GoogleLoginGroup'
          description: ''
      x-throttles:
      - scope_key: workspace_id
        limit: 300
        period: min
    put:
      operationId: google_login_groups_update
      description: 'Update an existing Google Login Group.


        The base rate limit for this endpoint is:

        - 300 requests per min per workspace'
      summary: Update Google Login Group
      parameters:
      - in: path
        name: id
        schema:
          type: string
          format: uuid
        description: A UUID string identifying this google login group.
        required: true
      tags:
      - google-login-group
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GoogleLoginGroupRequest'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/GoogleLoginGroupRequest'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/GoogleLoginGroupRequest'
        required: true
      security:
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GoogleLoginGroup'
          description: ''
      x-throttles:
      - scope_key: workspace_id
        limit: 300
        period: min
    patch:
      operationId: google_login_groups_partial_update
      description: 'Partial Update an existing Google Login Group.


        The base rate limit for this endpoint is:

        - 300 requests per min per workspace'
      summary: Partial Update Google Login Group
      parameters:
      - in: path
        name: id
        schema:
          type: string
          format: uuid
        description: A UUID string identifying this google login group.
        required: true
      tags:
      - google-login-group
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PatchedGoogleLoginGroupRequest'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/PatchedGoogleLoginGroupRequest'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/PatchedGoogleLoginGroupRequest'
      security:
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GoogleLoginGroup'
          description: ''
      x-throttles:
      - scope_key: workspace_id
        limit: 300
        period: min
    delete:
      operationId: google_login_groups_destroy
      description: 'Deletes an existing Google Login Group.


        The base rate limit for this endpoint is:

        - 300 requests per min per workspace'
      summary: Destroy Google Login Group
      parameters:
      - in: path
        name: id
        schema:
          type: string
          format: uuid
        description: A UUID string identifying this google login group.
        required: true
      tags:
      - google-login-group
      security:
      - tokenAuth: []
      responses:
        '204':
          description: No response body
      x-throttles:
      - scope_key: workspace_id
        limit: 300
        period: min
components:
  schemas:
    GoogleLoginGroup:
      type: object
      properties:
        id:
          type: string
          format: uuid
          readOnly: true
        name:
          type: string
          description: Name of the login group. It can used to filter out login groups when retrieving them via API.
          maxLength: 2000
        login_mode:
          allOf:
          - $ref: '#/components/schemas/LoginModeEnum'
          description: 'Login behaviour of bots that use this login group.


            * `always` - Always

            * `only_if_required` - Only If Required'
        created_at:
          type: string
          format: date-time
          readOnly: true
        updated_at:
          type: string
          format: date-time
          readOnly: true
        logins:
          type: array
          items:
            $ref: '#/components/schemas/GoogleLogin'
          readOnly: true
      required:
      - created_at
      - id
      - login_mode
      - logins
      - name
      - updated_at
    GoogleLogin:
      type: object
      properties:
        id:
          type: string
          format: uuid
          readOnly: true
        email:
          type: string
          format: email
          description: The email address of the google account to use for login.
        is_active:
          type: boolean
          description: 'If the login should be used for round robin. (default: true)'
        sso_v2_workspace_domain:
          type: string
          description: The primary domain name of your Google Workspace Account used for SSO.
        sso_v2_private_key:
          type: string
          description: PEM-formatted private key used for signing SSO requests.
        sso_v2_cert:
          type: string
          description: PEM-formatted x509 certificate which is registered in your Google Workspace SSO Profile.
        group_id:
          type: string
          format: uuid
          description: The id of the login group this login belongs to.
        created_at:
          type: string
          format: date-time
          readOnly: true
        updated_at:
          type: string
          format: date-time
          readOnly: true
      required:
      - created_at
      - email
      - group_id
      - id
      - sso_v2_cert
      - sso_v2_private_key
      - sso_v2_workspace_domain
      - updated_at
    PatchedGoogleLoginGroupRequest:
      type: object
      properties:
        name:
          type: string
          minLength: 1
          description: Name of the login group. It can used to filter out login groups when retrieving them via API.
          maxLength: 2000
        login_mode:
          allOf:
          - $ref: '#/components/schemas/LoginModeEnum'
          description: 'Login behaviour of bots that use this login group.


            * `always` - Always

            * `only_if_required` - Only If Required'
    PaginatedGoogleLoginGroupList:
      type: object
      properties:
        next:
          type:
          - string
          - 'null'
        previous:
          type:
          - string
          - 'null'
        results:
          type: array
          items:
            $ref: '#/components/schemas/GoogleLoginGroup'
    LoginModeEnum:
      enum:
      - always
      - only_if_required
      type: string
      description: '* `always` - Always

        * `only_if_required` - Only If Required'
    GoogleLoginGroupRequest:
      type: object
      properties:
        name:
          type: string
          minLength: 1
          description: Name of the login group. It can used to filter out login groups when retrieving them via API.
          maxLength: 2000
        login_mode:
          allOf:
          - $ref: '#/components/schemas/LoginModeEnum'
          description: 'Login behaviour of bots that use this login group.


            * `always` - Always

            * `only_if_required` - Only If Required'
      required:
      - login_mode
      - name
  securitySchemes:
    tokenAuth:
      type: apiKey
      in: header
      name: Authorization
      description: Token-based authentication with required prefix "Token"
    CalendarJwtAuthentication:
      type: apiKey
      in: header
      name: x-recallcalendarauthtoken
x-provenance:
  method: searched
  source: https://docs.recall.ai/reference
  harvested: '2026-10-14'
  tool: harvest-readme-openapi.py
  note: Assembled verbatim from the OpenAPI definition ReadMe embeds in each operation page of the provider's developer portal; paths and components merged by API title, nothing authored.
  assembled_from:
  - https://docs.recall.ai/reference/audio_mixed_destroy.md
  - https://docs.recall.ai/reference/audio_mixed_list.md
  - https://docs.recall.ai/reference/audio_mixed_partial_update.md
  - https://docs.recall.ai/reference/audio_mixed_retrieve.md
  - https://docs.recall.ai/reference/audio_separate_destroy.md
  - https://docs.recall.ai/reference/audio_separate_list.md
  - https://docs.recall.ai/reference/audio_separate_partial_update.md
  - https://docs.recall.ai/reference/audio_separate_retrieve.md
  - https://docs.recall.ai/reference/billing_usage_retrieve.md
  - https://docs.recall.ai/reference/bot_create.md
  - https://docs.recall.ai/reference/bot_delete_media_create.md
  - https://docs.recall.ai/reference/bot_destroy.md
  - https://docs.recall.ai/reference/bot_leave_call_create.md
  - https://docs.recall.ai/reference/bot_list.md
  - https://docs.recall.ai/reference/bot_output_audio_create.md
  - https://docs.recall.ai/reference/bot_output_audio_destroy.md
  - https://docs.recall.ai/reference/bot_output_media_create.md
  - https://docs.recall.ai/reference/bot_output_media_destroy.md
  - https://docs.recall.ai/reference/bot_output_screenshare_create.md
  - https://docs.recall.ai/reference/bot_output_screenshare_destroy.md
  - https://docs.recall.ai/reference/bot_output_video_create.md
  - https://docs.recall.ai/reference/bot_output_video_destroy.md
  - https://docs.recall.ai/reference/bot_partial_update.md
  - https://docs.recall.ai/reference/bot_pause_recording_create.md
  - https://docs.recall.ai/reference/bot_pin_participant_create.md
  - https://docs.recall.ai/reference/bot_resume_recording_create.md
  - https://docs.recall.ai/reference/bot_retrieve.md
  - https://docs.recall.ai/reference/bot_send_chat_message_create.md
  - https://docs.recall.ai/reference/bot_start_recording_create.md
  - https://docs.recall.ai/reference/bot_stop_recording_create.md
  - https://docs.recall.ai/reference/calendar_authenticate_create.md
  - https://docs.recall.ai/reference/calendar_events_bot_create.md
  - https://docs.recall.ai/reference/calendar_events_bot_destroy.md
  - https://docs.recall.ai/reference/calendar_events_list.md
  - https://docs.recall.ai/reference/calendar_events_retrieve.md
  - https://docs.recall.ai/reference/calendar_meetings_list.md
  - https://docs.recall.ai/reference/calendar_meetings_refresh_create.md
  - https://docs.recall.ai/reference/calendar_meetings_retrieve.md
  - https://docs.recall.ai/reference/calendar_meetings_update.md
  - https://docs.recall.ai/reference/calendar_user_destroy.md
  - https://docs.recall.ai/reference/calendar_user_disconnect_create.md
  - https://docs.recall.ai/reference/calendar_user_retrieve.md
  - https://docs.recall.ai/reference/calendar_user_update.md
  - https://docs.recall.ai/reference/calendar_users_list.md
  - https://docs.recall.ai/reference/calendars_access_token_create.md
  - https://docs.recall.ai/reference/calendars_create.md
  - https://docs.recall.ai/reference/calendars_destroy.md
  - https://docs.recall.ai/reference/calendars_list.md
  - https://docs.recall.ai/reference/calendars_partial_update.md
  - https://docs.recall.ai/reference/calendars_retrieve.md
  - https://docs.recall.ai/reference/google_login_groups_create.md
  - https://docs.recall.ai/reference/google_login_groups_destroy.md
  - https://docs.recall.ai/reference/google_login_groups_list.md
  - https://docs.recall.ai/reference/google_login_groups_partial_update.md
  - https://docs.recall.ai/reference/google_login_groups_retrieve.md
  - https://docs.recall.ai/reference/google_login_groups_update.md
  - https://docs.recall.ai/reference/google_logins_create.md
  - https://docs.recall.ai/reference/google_logins_destroy.md
  - https://docs.recall.ai/reference/google_logins_list.md
  - https://docs.recall.ai/reference/google_logins_partial_update.md
  - https://docs.recall.ai/reference/google_logins_retrieve.md
  - https://docs.recall.ai/reference/google_logins_update.md
  - https://docs.recall.ai/reference/meeting_direct_connect_create.md
  - https://docs.recall.ai/reference/meeting_direct_connect_list.md
  - https://docs.recall.ai/reference/meeting_direct_connect_retrieve.md
  - https://docs.recall.ai/reference/meeting_metadata_destroy.md
  - https://docs.recall.ai/reference/meeting_metadata_list.md
  - https://docs.recall.ai/reference/meeting_metadata_partial_update.md
  - https://docs.recall.ai/reference/meeting_metadata_retrieve.md
  - https://docs.recall.ai/reference/participant_events_destroy.md
  - https://docs.recall.ai/reference/participant_events_list.md
  - https://docs.recall.ai/reference/participant_events_partial_update.md
  - https://docs.recall.ai/reference/participant_events_retrieve.md
  - https://docs.recall.ai/reference/realtime_endpoint_list.md
  - https://docs.recall.ai/reference/realtime_endpoint_partial_update.md
  - https://docs.recall.ai/reference/realtime_endpoint_retrieve.md
  - https://docs.recall.ai/reference/recording_create_transcript_create.md
  - https://docs.recall.ai/reference/recording_destroy.md
  - https://docs.recall.ai/reference/recording_list.md
  - https://docs.recall.ai/reference/recording_partial_update.md
  - https://docs.recall.ai/reference/recording_retrieve.md
  - https://docs.recall.ai/reference/sdk_upload_create.md
  - https://docs.recall.ai/reference/sdk_upload_list.md
  - https://docs.recall.ai/reference/sdk_upload_retrieve.md
  - https://docs.recall.ai/reference/transcript_destroy.md
  - https://docs.recall.ai/reference/transcript_list.md
  - https://docs.recall.ai/reference/transcript_partial_update.md
  - https://docs.recall.ai/reference/transcript_retrieve.md
  - https://docs.recall.ai/reference/video_mixed_destroy.md
  - https://docs.recall.ai/reference/video_mixed_list.md
  - https://docs.recall.ai/reference/video_mixed_partial_update.md
  - https://docs.recall.ai/reference/video_mixed_retrieve.md
  - https://docs.recall.ai/reference/video_separate_destroy.md
  - https://docs.recall.ai/reference/video_separate_list.md
  - https://docs.recall.ai/reference/video_separate_partial_update.md
  - https://docs.recall.ai/reference/video_separate_retrieve.md
  - https://docs.recall.ai/reference/zoom_meetings_to_credentials_list.md
  - https://docs.recall.ai/reference/zoom_oauth_app_logs_list.md
  - https://docs.recall.ai/reference/zoom_oauth_apps_create.md
  - https://docs.recall.ai/reference/zoom_oauth_apps_destroy.md
  - https://docs.recall.ai/reference/zoom_oauth_apps_list.md
  - https://docs.recall.ai/reference/zoom_oauth_apps_partial_update.md
  - https://docs.recall.ai/reference/zoom_oauth_apps_retrieve.md
  - https://docs.recall.ai/reference/zoom_oauth_credential_logs_list.md
  - https://docs.recall.ai/reference/zoom_oauth_credentials_access_token_retrieve.md
  - https://docs.recall.ai/reference/zoom_oauth_credentials_create.md
  - https://docs.recall.ai/reference/zoom_oauth_credentials_destroy.md
  - https://docs.recall.ai/reference/zoom_oauth_credentials_list.md
  - https://docs.recall.ai/reference/zoom_oauth_credentials_retrieve.md
  - https://docs.recall.ai/reference/zoom_oauth_credentials_sync_meetings_create.md
  - https://docs.recall.ai/reference/zoom_oauth_credentials_validate_create.md
  merge:
    pages: 111
    deduped: 2254
    conflicts_kept_first: 0