openapi: 3.2.0
info:
  title: page Folder API
  version: '2.0'
servers:
- url: https://api.azuqua.com
security:
- sec0: []
  sec1: []
  sec2: []
tags:
- name: Folder
paths:
  /v2/folder:
    post:
      summary: Create Folder
      description: Create a folder in your organization with a given name and description.
      operationId: create-folder
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                name:
                  type: string
                  description: The name of the new folder.
                description:
                  type: string
                  description: The description of the new folder.
      responses:
        '200':
          description: '200'
          content:
            application/json:
              examples:
                Result:
                  value: '{ "id": 123 }'
              schema:
                type: object
                properties:
                  id:
                    type: integer
                    example: 123
                    default: 0
      deprecated: false
      tags:
      - Folder
  /v2/folder/{folder_id}:
    delete:
      summary: Delete Folder
      description: Delete a given folder.
      operationId: delete-tab
      parameters:
      - name: folder_id
        in: path
        description: The ID of the folder you'd like to delete.
        schema:
          type: integer
          format: int32
        required: true
      responses:
        '200':
          description: '200'
          content:
            application/json:
              examples:
                Result:
                  value: '{ "deleted": true }'
              schema:
                type: object
                properties:
                  deleted:
                    type: boolean
                    example: true
                    default: true
        '403':
          description: '403'
          content:
            application/json:
              examples:
                Result:
                  value: "//Occurs if you do not have access to the given folder, or it does not exist\n{\n  \"errors\": \n   [ \n     { \n       \"title\": 'Forbidden',\n       \"message\": 'Forbidden. Refer to documentation about how to use this route' \n     } \n   ] \n}"
      deprecated: false
      tags:
      - Folder
    get:
      summary: Read Folder
      description: Read the metadata about a given folder.
      operationId: read-folder
      parameters:
      - name: folder_id
        in: path
        description: The ID of the folder you'd like to read from.
        schema:
          type: integer
          format: int32
        required: true
      responses:
        '200':
          description: '200'
          content:
            application/json:
              examples:
                Result:
                  value: "{ \n  \"id\": 123,\n  \"org_id\": 123,\n  \"user_id\": 123,\n  \"name\": 'Shared Folder',\n  \"description\": 'This is my description',\n  \"privileges\": \n   [ { \"resource\": 'GROUP', \"privilege\": 'ADD' },\n     { \"resource\": 'GROUP', \"privilege\": 'WRITE' },\n     { \"resource\": 'GROUP', \"privilege\": 'REMOVE' },\n     { \"resource\": 'GROUP', \"privilege\": 'DELETE' },\n     { \"resource\": 'GROUP', \"privilege\": 'READ' },\n     { \"resource\": 'GROUP', \"privilege\": 'CREATEGROUPMESSAGE' },\n     { \"resource\": 'GROUP', \"privilege\": 'LIST' },\n     { \"resource\": 'FLO', \"privilege\": 'CHANGEROLE' },\n     { \"resource\": 'FLO', \"privilege\": 'WRITE' },\n     { \"resource\": 'FLO', \"privilege\": 'READDATA' },\n     { \"resource\": 'FLO', \"privilege\": 'ADD' },\n     { \"resource\": 'FLO', \"privilege\": 'REMOVE' },\n     { \"resource\": 'FLO', \"privilege\": 'DUPLICATE' },\n     { \"resource\": 'FLO', \"privilege\": 'SHARE' },\n     { \"resource\": 'FLO', \"privilege\": 'DELETE' },\n     { \"resource\": 'FLO', \"privilege\": 'MOVE' },\n     { \"resource\": 'FLO', \"privilege\": 'READ' },\n     { \"resource\": 'FLO', \"privilege\": 'LIST' },\n     { \"resource\": 'FLO', \"privilege\": 'EXECUTE' } ],\n  \"role_type\": 'OWNER' \n}\n"
        '404':
          description: '404'
          content:
            application/json:
              examples:
                Result:
                  value: "//Occurs when you either don't have access to the folder, or the folder does not exist\n{ \n  \"errors\": \n   [ \n     { \n       \"title\": 'Not Found',\n       \"message\": 'Not Found. Check that you have access to resource' \n     } \n   ] \n}"
      deprecated: false
      tags:
      - Folder
    put:
      summary: Update Folder
      description: Update metadata about a folder (name, description).
      operationId: update-folder
      parameters:
      - name: folder_id
        in: path
        description: The ID of the folder you'd like to update.
        schema:
          type: integer
          format: int32
        required: true
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                name:
                  type: string
                  description: The name that will replace your folder's existing name.
                description:
                  type: string
                  description: The description that will replace your folder's current description.
      responses:
        '200':
          description: '200'
          content:
            application/json:
              examples:
                Result:
                  value: "//This will return the information changed back to you. In this case, the user changed both the name and description\n{ \n  \"name\": 'THIS IS NEW', \n  \"description\": 'I, TOO, AM NEW' \n}"
        '403':
          description: '403'
          content:
            application/json:
              examples:
                Result:
                  value: "//Occurs when the folder doesn't exist, or you don't have access to the folder\n{\n  \"errors\": \n   [ \n     { \n       \"title\": 'Forbidden',\n       \"message\": 'Forbidden. Refer to documentation about how to use this route' \n     } \n   ] \n}"
      deprecated: false
      tags:
      - Folder
  /v2/folder/{folder_id}/flos:
    get:
      summary: Read FLOs in Folder
      description: Read all FLOs inside of a given folder.
      operationId: read-flos-in-folder
      parameters:
      - name: folder_id
        in: path
        description: The ID of the folder you'd like read FLOs from.
        schema:
          type: integer
          format: int32
        required: true
      responses:
        '200':
          description: '200'
          content:
            application/json:
              examples:
                Result:
                  value: "[ \n  { \n    \"id\": 123,\n    \"alias\": 'abcdefghijklmnopqrstuv',\n    \"name\": 'Test with Event',\n    \"type\": null,\n    \"active\": false,\n    \"published\": false,\n    \"security_level\": null,\n    \"client_token\": 'clientTokenOfMyFlo',\n    \"description\": '',\n    \"created\": '2017-07-31T16:35:48.624Z',\n    \"updated\": '2017-07-31T17:00:53.624Z',\n    \"role_type\": 'CREATOR' \n  } \n]"
        '404':
          description: '404'
          content:
            application/json:
              examples:
                Result:
                  value: "//Occurs if the folder does not exist, or if there are no flos in the folder\n{ \n  \"errors\": \n   [ \n     { \n       \"title\": 'Not Found',\n       \"message\": 'Not Found. Check that you have access to resource' \n     } \n   ] \n}\n"
      deprecated: false
      tags:
      - Folder
  /v2/folder/{folder_id}/user/{user_id}/permissions:
    put:
      summary: Update User Permissions to Folder
      description: Update the permissions a user has a on a given folder.
      operationId: add-user-to-tab-1
      parameters:
      - name: folder_id
        in: path
        description: The ID of the folder you'd like to adjust user permissions to.
        schema:
          type: integer
          format: int32
        required: true
      - name: user_id
        in: path
        description: The ID of the user whose permissions you'd like to adjust on this folder.
        schema:
          type: integer
          format: int32
        required: true
      requestBody:
        content:
          application/json:
            schema:
              type: object
              required:
              - role
              properties:
                role:
                  type: string
                  description: The role you'd like to change your user to. Can be "NONE", "RUN", "USE", "EDIT".
      responses:
        '200':
          description: '200'
          content:
            application/json:
              examples:
                Result:
                  value: '{ "changed": true }'
              schema:
                type: object
                properties:
                  changed:
                    type: boolean
                    example: true
                    default: true
        '400':
          description: '400'
          content:
            application/json:
              examples:
                Result:
                  value: "//Occurs if you pass in an invalid value as the \"role\" parameter \n{ \n  \"errors\": \n   [ \n     { \n       \"title\": 'Bad Request',\n       \"message\": 'Error at parameter role: No enum match for: \"INVALID_NAME_HERE\"' \n     } \n   ] \n}"
        '404':
          description: '404'
          content:
            application/json:
              examples:
                Result:
                  value: "//Occurs if the folder or user doesn't exist\n{ \n  \"errors\": \n   [ \n     { \n       \"title\": 'Not Found',\n       \"message\": 'Not Found. Check that you have access to resource' \n     }\n   ]\n}"
      deprecated: false
      tags:
      - Folder
  /v2/folder/{folder_id}/users:
    get:
      summary: Read Folder Users
      description: Read all the users that have access to a folder.
      operationId: read-folder-users
      parameters:
      - name: folder_id
        in: path
        description: The ID of the folder you would like to read users from.
        schema:
          type: integer
          format: int32
        required: true
      responses:
        '200':
          description: '200'
          content:
            application/json:
              examples:
                Result:
                  value: "[ \n  {\n    \"id\": 123,\n    \"email\": '-@email.com',\n    \"company\": 'Azuqua',\n    \"first_name\": 'First Name',\n    \"last_name\": 'Last Name'\n  } \n]\n"
        '404':
          description: '404'
          content:
            application/json:
              examples:
                Result:
                  value: "//Occurs when the folder does not exist or when you do not have access to the folder\n{ \n  \"errors\": \n   [ \n     { \n       \"title\": 'Not Found',\n       \"message\": 'Not Found. Check that you have access to resource' \n     }\n   ]\n}"
      deprecated: false
      tags:
      - Folder
components:
  securitySchemes:
    sec0:
      type: apiKey
      in: header
      name: x-api-accesskey
    sec1:
      type: apiKey
      in: header
      name: x-api-hash
    sec2:
      type: apiKey
      in: header
      name: x-api-timestamp
x-readme-fauxas: true
x-provenance:
  method: searched
  source: https://docs.azuqua.com/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.azuqua.com/reference/add-user-to-tab-1.md
  - https://docs.azuqua.com/reference/copy-flo-into-organization.md
  - https://docs.azuqua.com/reference/create-folder.md
  - https://docs.azuqua.com/reference/delete-account.md
  - https://docs.azuqua.com/reference/delete-flo.md
  - https://docs.azuqua.com/reference/delete-tab.md
  - https://docs.azuqua.com/reference/disable-flo.md
  - https://docs.azuqua.com/reference/duplicate-flo.md
  - https://docs.azuqua.com/reference/enable-flo.md
  - https://docs.azuqua.com/reference/get-account.md
  - https://docs.azuqua.com/reference/get-accounts-for-flo.md
  - https://docs.azuqua.com/reference/get-connector-metadata.md
  - https://docs.azuqua.com/reference/get-flo-inputs.md
  - https://docs.azuqua.com/reference/get-flos-in-organization.md
  - https://docs.azuqua.com/reference/get-folders.md
  - https://docs.azuqua.com/reference/move-flo-to-folder.md
  - https://docs.azuqua.com/reference/read-account.md
  - https://docs.azuqua.com/reference/read-flo.md
  - https://docs.azuqua.com/reference/read-flos-in-folder.md
  - https://docs.azuqua.com/reference/read-folder-users.md
  - https://docs.azuqua.com/reference/read-folder.md
  - https://docs.azuqua.com/reference/read-organization.md
  - https://docs.azuqua.com/reference/read-user-orgs.md
  - https://docs.azuqua.com/reference/share-account.md
  - https://docs.azuqua.com/reference/update-flo-metadata.md
  - https://docs.azuqua.com/reference/update-folder.md
  - https://docs.azuqua.com/reference/update-org.md
  - https://docs.azuqua.com/reference/update-user-role.md
  merge:
    pages: 28
    deduped: 81
    conflicts_kept_first: 0