Fax for Agents Organizations API

openapi: 3.2.0
info:
  title: Faxforagents Organizations API
  version: 1.4.3
  contact:
    name: Fax for Agents
    url: https://faxforagents.com/contact/
    email: hello@faxforagents.com
  termsOfService: https://faxforagents.com/terms/
  x-refined-note:
  - x-snapshot differs across the merged source definitions and was not carried
  description: 'Operations tagged organizations across 2 of this provider''s published API definitions: faxforagents-api-openapi.json, faxforagents-site-openapi.json. Each path carries the servers of the definition it was published in.'
servers:
- url: https://api.faxforagents.com
  description: Production
tags:
- name: Organizations
paths:
  /v1/organizations:
    get:
      tags:
      - Organizations
      summary: The organizations you belong to
      operationId: list_organizations
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OrganizationList'
  /v1/organizations/current:
    get:
      tags:
      - Organizations
      summary: The organization you are looking at
      operationId: get_current_organization
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Organization'
    patch:
      tags:
      - Organizations
      summary: Rename the organization
      operationId: update_current_organization
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/OrganizationPatch'
        required: true
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Organization'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /v1/organizations/current/export-requests:
    post:
      tags:
      - Organizations
      summary: Ask for an export of the organization's data (owner)
      operationId: request_data_export
      responses:
        '202':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Requested'
  /v1/organizations/current/deletion-requests:
    post:
      tags:
      - Organizations
      summary: Ask for the organization and its data to be deleted (owner)
      operationId: request_data_deletion
      responses:
        '202':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Requested'
components:
  schemas:
    OrganizationSummary:
      properties:
        id:
          type: string
          title: Id
        name:
          type: string
          title: Name
        role:
          type: string
          enum:
          - owner
          - admin
          - member
          - viewer
          title: Role
      additionalProperties: true
      type: object
      required:
      - id
      - name
      - role
      title: OrganizationSummary
    Requested:
      properties:
        requested:
          type: boolean
          title: Requested
        kind:
          type: string
          enum:
          - export
          - deletion
          title: Kind
        message:
          type: string
          title: Message
      additionalProperties: true
      type: object
      required:
      - requested
      - kind
      - message
      title: Requested
    OrganizationList:
      properties:
        items:
          items:
            $ref: '#/components/schemas/OrganizationSummary'
          type: array
          title: Items
      additionalProperties: true
      type: object
      required:
      - items
      title: OrganizationList
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
            - type: string
            - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
        input:
          title: Input
        ctx:
          type: object
          title: Context
      type: object
      required:
      - loc
      - msg
      - type
      title: ValidationError
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    OrganizationPatch:
      properties:
        name:
          type: string
          maxLength: 200
          minLength: 1
          title: Name
      additionalProperties: false
      type: object
      required:
      - name
      title: OrganizationPatch
    Organization:
      properties:
        id:
          type: string
          title: Id
        name:
          type: string
          title: Name
        role:
          anyOf:
          - type: string
            enum:
            - owner
            - admin
            - member
            - viewer
          - type: 'null'
          title: Role
        created_at:
          type: string
          title: Created At
        members:
          type: integer
          title: Members
      additionalProperties: true
      type: object
      required:
      - id
      - name
      - role
      - created_at
      - members
      title: Organization
x-refined-from:
- faxforagents-api-openapi.json
- faxforagents-site-openapi.json