Grepr Invitations API

openapi: 3.2.0
info:
  title: Grepr Invitations API
  version: 1.0.0
  description: 'Operations tagged Invitations across 2 of this provider''s published API definitions: grepr-openapi.json, grepr.json. Each path carries the servers of the definition it was published in.'
tags:
- description: Manage user invitations to your organization
  name: Invitations
paths:
  /v1/invitations:
    get:
      operationId: listInvitations
      parameters:
      - in: query
        name: page
        schema:
          default: 0
          format: int32
          minimum: 0
          type: integer
      - in: query
        name: pageSize
        schema:
          default: 10
          format: int32
          minimum: 1
          type: integer
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvitationsList'
          description: Invitations made for this organization
        '401':
          description: Unauthorized
      security:
      - grepr-api-key: []
      summary: Get all invitations
      tags:
      - Invitations
    post:
      operationId: invite
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Invitee'
      responses:
        '200':
          description: Invitations created successfully
        '401':
          description: Unauthorized
      security:
      - grepr-api-key: []
      summary: Invite multiple people
      tags:
      - Invitations
  /v1/invitations/{id}:
    delete:
      operationId: deleteInvitation
      parameters:
      - in: path
        name: id
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Invitation deleted successfully
        '401':
          description: Unauthorized
      security:
      - grepr-api-key: []
      summary: Delete an invitation
      tags:
      - Invitations
    get:
      operationId: getInvitation
      parameters:
      - in: path
        name: id
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ReadInvitation'
          description: Invitation retrieved successfully
        '401':
          description: Unauthorized
      security:
      - grepr-api-key: []
      summary: Get an invitation by id
      tags:
      - Invitations
components:
  schemas:
    Invitee:
      properties:
        email:
          type: string
        roleIds:
          default: []
          description: Role IDs assigned to the invitation
          items:
            description: Role IDs assigned to the invitation
            type: string
          type: array
          uniqueItems: true
        teamAssignments:
          default: []
          description: Team-specific role assignments
          items:
            $ref: '#/components/schemas/TeamAssignment'
          type: array
          uniqueItems: true
      type: object
    ItemsCollectionReadInvitation:
      properties:
        items:
          default: []
          items:
            $ref: '#/components/schemas/ReadInvitation'
          type: array
      type: object
    ReadInvitation:
      properties:
        createdAt:
          format: date-time
          type: string
        expiresAt:
          format: date-time
          type: string
        id:
          type: string
        inviteeEmail:
          type: string
        inviterName:
          type: string
        roleIds:
          default: []
          description: Role IDs assigned to the invitation
          items:
            description: Role IDs assigned to the invitation
            type: string
          type: array
          uniqueItems: true
        teamAssignments:
          default: []
          description: Team-specific role assignments
          items:
            $ref: '#/components/schemas/TeamAssignment'
          type: array
          uniqueItems: true
      type: object
    InvitationsList:
      properties:
        invitations:
          $ref: '#/components/schemas/ItemsCollectionReadInvitation'
        limit:
          format: int32
          type: integer
        start:
          format: int32
          type: integer
      type: object
    TeamAssignment:
      description: Team and role assignment
      properties:
        role:
          description: The role within the team
          enum:
          - LEADER
          - MEMBER
          type: string
        teamId:
          description: The ID of the team
          example: team123
          type: string
        teamName:
          description: Team name (response-only, enriched by server)
          readOnly: true
          type: string
      required:
      - role
      - teamId
      type: object
  securitySchemes:
    grepr-api-key:
      in: header
      name: GREPR-API-KEY
      type: apiKey
    grepr-oidc:
      bearerFormat: JWT
      openIdConnectUrl: https://grepr-prod.us.auth0.com/.well-known/openid-configuration
      type: openIdConnect
x-refined-from:
- grepr-openapi.json
- grepr.json
x-tagGroups:
- name: Integrations
  tags:
  - Grepr-hosted Data Warehouse Integration
  - External S3 Data Warehouse Integration
  - Datadog Integration
  - New Relic Integration
  - Splunk Integration
  - Sumo Logic Integration
  - OpenTelemetry Integration
- name: Pipelines
  tags:
  - Jobs
  - Templates
  - Datasets
  - Status Metrics
  - External Triggers
  - Job Actions
  - Triggers
- name: Pipeline Components
  tags:
  - Operations
  - Transforms
  - Sources
  - Sinks
- name: Administration
  tags:
  - Users
  - Teams
  - Roles
  - Permission
  - Invitations
  - Activity Logs
- name: Organization
  tags:
  - Organizations
  - Access Configuration
  - Grepr API Key
  - Service Accounts
  - Signup
- name: Query & Analysis
  tags:
  - Job Anomalies
  - Grok Parsing
  - Query Parsing
  - Validation
- name: System
  tags:
  - Manifest