Frihet Team API

openapi: 3.2.0
info:
  title: Frihet Team API
  version: '2026-03-18'
  description: 'The Frihet REST API provides programmatic access to your business data

    in Frihet, the AI-native business management platform for modern businesses. ## Authentication


    All API requests require an API key passed via the `X-API-Key` header. Generate keys from **Settings > API Keys** in the Frihet app. ```

    X-API-Key: fri_your_api_key_here

    ```


    ### API-key scopes


    A key without scopes (no list, or an empty one) is unrestricted. A key with a

    non-empty scope list gets only what the list grants. On such a key, every

    request other than `GET` and `HEAD` needs the `write` scope (or `*`), except

    the read-only `POST /v1/gestoria/aging` and the POS and purchase-order routes,

    which check their own `pos:` and `purchase-orders:` scopes. E-invoicing endpoints need an `einvoice:` scope,

    and the sends (`einvoice/export`, `face/submit`, `ticketbai/submit`) also need

    `write` or `einvoice:write`. A request without the scope it needs gets

    `403 Forbidden` with a `detail` naming that scope. The refusal happens before

    the idempotency gate, so it does not reserve the `Idempotency-Key`. `GET /v1/permissions/me` reports `denied.write`, `denied.einvoice` and

    `denied.einvoiceSend` for the calling key. Inventory (`/v1/inventory/*`) and purchase-order (`/v1/purchase-orders/*`) routes are

    not released yet: after the scope checks they answer `503` with code

    `INVENTORY_AUTHORITY_NOT_RELEASED`, before the idempotency gate. ## Rate Limiting


    The API enforces a rate limit of **100 requests per minute** per API key. When exceeded, the API returns `429 Too Many Requests` with an integer

    delta-seconds `Retry-After` header and matching `retryAfter` JSON field. Every authenticated response includes rate limit headers:


    | Header | Description |

    |--------|-------------|

    | `X-RateLimit-Limit` | Maximum requests per window (100) |

    | `X-RateLimit-Remaining` | Remaining requests in current window |

    | `X-RateLimit-Reset` | Unix timestamp (seconds) when the window resets |

    | `Retry-After` | Integer seconds until the window resets (429 responses) |


    ## Idempotency


    Most POST requests accept an `Idempotency-Key` header to prevent duplicate

    resource creation from network retries. For protected routes, the key is

    reserved against the operation *before* the request is executed, and it stays

    reserved for 24 hours unless released by an explicit pre-write refusal. ```

    Idempotency-Key: 550e8400-e29b-41d4-a716-446655440000

    ```


    Keys must be at most 64 characters. We recommend UUID v4. A retry of the same operation gets one of three answers:


    | Situation | Response |

    |---|---|

    | The first request finished | The **original status and body**, verbatim, with `X-Idempotent-Replayed: true` |

    | The first request is still running, or its outcome could not be recorded | `409 IDEMPOTENCY_REQUEST_IN_PROGRESS` |

    | The key is live but was used for a **different** operation | `409 IDEMPOTENCY_KEY_REUSED` — the second operation is not executed |


    The replayed status is the **stored** one. A `201` replays as `201`, not `200`. This includes stored error responses: a request that answered `4xx` or `5xx`

    replays that same status and body, it does not re-execute — except explicit

    pre-mutation refusals on `POST /v1/pos/cash-sessions/{id}/close` (`503` when

    the workspace POS money-authority grant is not enabled and `403 POS_INACTIVE`

    before the POS app is activated), which release the reservation instead of

    caching the refusal for 24 hours. ### When a retry is refused


    A `409 IDEMPOTENCY_REQUEST_IN_PROGRESS` after the first request already

    returned means the outcome could not be recorded — the response was too large

    or unserializable, or the bookkeeping write failed. The API refuses rather than

    execute a second time, because for a fiscal document a duplicate is not

    recoverable. **Reconcile; do not simply retry with a fresh key.** Read the resource back

    (`GET` the collection, or look for the document the operation would have

    created) and decide from its actual state.'
  contact:
    name: Frihet API Support
    url: https://docs.frihet.io/desarrolladores/api-rest
    email: api@frihet.io
  license:
    name: MIT
    url: https://opensource.org/licenses/MIT
  x-logo:
    url: https://frihet.io/logos/frihet-logo.svg
servers:
- url: https://api.frihet.io
  description: Production
security:
- ApiKeyAuth: []
tags:
- name: Team
paths:
  /v1/team/members:
    get:
      operationId: listTeamMembers
      summary: List team members
      description: 'Returns active team members plus every non-terminal invitation for the workspace, each labelled with its effective state computed at read time (`pending`, `expired`, or `invalid`). Accepted and revoked invitations are not listed. This endpoint is the recovery path for `invalid` rows: list them, then revoke via DELETE /v1/team/members/{memberId}.'
      tags:
      - Team
      security:
      - ApiKeyAuth: []
      parameters:
      - name: role
        in: query
        schema:
          type: string
          enum:
          - owner
          - admin
          - viewer
          - editor
          - accountant
      - name: status
        in: query
        schema:
          type: string
          enum:
          - active
          - pending
          - expired
          - invalid
        description: Filter by effective state. `active` = joined member. `pending` = invitation not yet accepted and not yet past its expiry. `expired` = invitation proven past `expiresAt` (holds no seat). `invalid` = invitation whose validity cannot be proven (missing or unparseable `expiresAt`, unknown persisted status, or a role that is not an assignable team role). An `invalid` invitation conservatively HOLDS its seat and can only be released by revoking it via DELETE /v1/team/members/{memberId}.
      - name: limit
        in: query
        schema:
          type: integer
          minimum: 1
          maximum: 100
          default: 50
      - name: offset
        in: query
        schema:
          type: integer
          minimum: 0
          default: 0
      responses:
        '200':
          description: List of team members and pending invitations
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/TeamMember'
                  total:
                    type: integer
                  limit:
                    type: integer
                  offset:
                    type: integer
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '429':
          $ref: '#/components/responses/RateLimited'
        '500':
          $ref: '#/components/responses/InternalError'
  /v1/team/members/invite:
    post:
      operationId: inviteTeamMember
      summary: Invite a team member
      description: 'Send an email invitation to join the workspace. Subject to plan seat limits (free: 1; pro, Premium and enterprise: unlimited). Invitation expires in 7 days.'
      tags:
      - Team
      security:
      - ApiKeyAuth: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/TeamInviteRequest'
      responses:
        '201':
          description: Invitation sent
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      id:
                        type: string
                      email:
                        type: string
                      role:
                        type: string
                      name:
                        type: string
                        nullable: true
                      status:
                        type: string
                        enum:
                        - pending
                      expiresAt:
                        type: string
                        format: date-time
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/WriteScopeForbidden'
        '409':
          description: Conflict — user already a member, invite already pending, or seat limit reached
        '429':
          $ref: '#/components/responses/RateLimited'
        '500':
          $ref: '#/components/responses/InternalError'
  /v1/team/members/{memberId}:
    delete:
      operationId: removeTeamMember
      summary: Remove team member or revoke pending invitation
      description: Removes an active team member or revokes a pending invitation by ID. The workspace owner cannot be removed. For pending invitations, pass the invitation document ID returned by POST /v1/team/members/invite.
      tags:
      - Team
      security:
      - ApiKeyAuth: []
      parameters:
      - name: memberId
        in: path
        required: true
        schema:
          type: string
        description: Active member ID or pending invitation ID
      responses:
        '204':
          description: Member removed or invitation revoked
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          description: Cannot remove workspace owner
        '404':
          description: Member or invitation not found
        '409':
          description: Invitation is no longer revocable. Only the terminal states (`accepted`, `revoked`) refuse revocation; `pending`, `expired` and `invalid` invitations are all revocable so the owner can release the seat.
        '429':
          $ref: '#/components/responses/RateLimited'
        '500':
          $ref: '#/components/responses/InternalError'
  /v1/team/members/{memberId}/role:
    patch:
      operationId: updateTeamMemberRole
      summary: Change a team member's role
      description: Update the role of an active team member. Cannot change the workspace owner's role.
      tags:
      - Team
      security:
      - ApiKeyAuth: []
      parameters:
      - name: memberId
        in: path
        required: true
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/TeamRoleUpdateRequest'
      responses:
        '200':
          description: Role updated
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      id:
                        type: string
                      role:
                        type: string
                      updatedAt:
                        type: string
                        format: date-time
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          description: Cannot change workspace owner role
        '404':
          description: Team member not found
        '429':
          $ref: '#/components/responses/RateLimited'
        '500':
          $ref: '#/components/responses/InternalError'
components:
  responses:
    RateLimited:
      description: Rate limit exceeded (100 requests per minute)
      headers:
        Retry-After:
          description: Integer seconds until the current rate-limit window resets
          schema:
            type: integer
            minimum: 1
          example: 60
        X-RateLimit-Reset:
          $ref: '#/components/headers/X-RateLimit-Reset'
      content:
        application/json:
          schema:
            type: object
            properties:
              error:
                type: string
                example: Rate limit exceeded
              message:
                type: string
                example: Maximum 100 requests per minute
              retryAfter:
                type: integer
                description: Seconds until rate limit resets
                example: 60
              meta:
                type: object
                properties:
                  requestId:
                    type: string
    WriteScopeForbidden:
      description: Write scope required to mutate, send or submit. The API key must include the `write` scope (or `einvoice:write` for e-invoice sends) or be unrestricted.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error: Forbidden
            detail: This API key does not have the write scope required to create, update, delete, send or submit. E-invoice sends also accept einvoice:write. Use an API key with write access.
            meta:
              requestId: 550e8400-e29b-41d4-a716-446655440000
    BadRequest:
      description: Bad request - invalid parameters or request body
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error: Validation error
            details:
            - code: invalid_type
              message: Required
              path:
              - clientName
            meta:
              requestId: 550e8400-e29b-41d4-a716-446655440000
    Unauthorized:
      description: Authentication required or invalid API key
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error: Invalid or expired API key
            meta:
              requestId: 550e8400-e29b-41d4-a716-446655440000
    InternalError:
      description: Internal server error
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error: Internal server error
            meta:
              requestId: 550e8400-e29b-41d4-a716-446655440000
  schemas:
    Error:
      type: object
      required:
      - error
      properties:
        error:
          type: string
          description: Human-readable error message
        code:
          type: string
          description: Optional machine-readable code, including MISSING_FISCAL_INFO, AEAT_QR_UNAVAILABLE (422) and AEAT_RECORD_IRREPRODUCIBLE (409) on invoice PDF.
        message:
          type: string
          description: Optional explanatory message accompanying the error code.
        details:
          type: array
          description: Validation error details (Zod issues). Only present on 400 validation errors.
          items:
            type: object
            properties:
              code:
                type: string
              message:
                type: string
              path:
                type: array
                items:
                  type: string
        meta:
          type: object
          properties:
            requestId:
              type: string
              description: Unique request identifier for tracing
    TeamRoleUpdateRequest:
      type: object
      required:
      - role
      properties:
        role:
          type: string
          enum:
          - admin
          - editor
          - accountant
          - viewer
      additionalProperties: false
    TeamMember:
      type: object
      properties:
        id:
          type: string
          description: Member or invitation document ID
        email:
          type: string
          format: email
        name:
          type: string
          nullable: true
        role:
          type: string
          nullable: true
          enum:
          - owner
          - admin
          - viewer
          - editor
          - accountant
          description: 'Null only on an invitation row whose persisted role is not an assignable team role. Such a row is always reported with `status: invalid`; the API will not invent a valid role for it. Revoke the row via DELETE /v1/team/members/{memberId} to release the seat it holds.'
        status:
          type: string
          enum:
          - active
          - pending
          - expired
          - invalid
          description: Effective state computed at read time, not merely the persisted field. `expired` is only reported when expiry is PROVEN and the row holds no seat; `invalid` means validity could not be proven and the row conservatively still holds its seat.
        joinedAt:
          type: string
          format: date-time
          nullable: true
          description: Set for active members
        invitedAt:
          type: string
          format: date-time
          nullable: true
          description: Set for pending invitations
        expiresAt:
          type: string
          format: date-time
          nullable: true
          description: Invite expiry (pending only)
    TeamInviteRequest:
      type: object
      required:
      - email
      - role
      properties:
        email:
          type: string
          format: email
          maxLength: 255
        role:
          type: string
          enum:
          - admin
          - editor
          - accountant
          - viewer
        name:
          type: string
          maxLength: 200
      additionalProperties: false
  headers:
    X-RateLimit-Reset:
      description: Unix timestamp (seconds) when the rate limit window resets
      schema:
        type: integer
        example: 1742310060
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: X-API-Key
      description: 'API key for authentication. Keys start with `fri_` prefix.

        Generate keys from Settings > API Keys in the Frihet app.

        '