"info:\n title: flowcode api 2\nopenapi: 3.0.0\ninfo:\n version: 1.0.0\n title: Flowcode API\n description: |\n ### API Support: help-api@flowcode.com\n\n # [Introduction](#introduction)\n \n The Flowcode API is a RESTful API that lets you programmatically leverage the Flowcode platform:\n <ul>\n <li>Create and manage Flowcodes at scale</li>\n <li>Extract real-time data from your Flowcodes and Flowpages</li>\n <li>Seamlessly integrate the API into your application</li>\n </ul>\n As we update and release newer versions of the API, we reserve the right to remove older APIs and functionality with a 1-month deprecation notice.\n We will post about such changes as well as announce new features in the Developers Central section of our community.\n <hr>\n\n # [Getting Started](#getting-started)\n Step 1: Register for the Developer Portal:\n <ol>\n <li>Click “Register” at the top right (Note: you will need a Flowcode account)</li>\n <li>Log into your Flowcode account in the new tab that opens</li>\n <li>Once you’ve logged in with the new tab, navigate back to the Developer Portal tab you had open</li>\n <li>In the Developer Portal tab, you should see a prompt to create an account (Note: this is a necessary step to register for the developer portal) with your email pre-populated and an input for phone number</li>\n <li>Input your phone number and click “Create Account”</li>\n <li>You should be redirected to the Overview page within the new Developer Portal</li>\n </ol>\n \n Step 2: Generate a new API Key\n <ol>\n <li>Hover on your email address in the top right of the Overview page in the Developer Portal</li>\n <li>Click on \"Generate a Key\" in the dropdown that appears</li>\n <li>Click “Create API Credential”</li>\n </ol>\n\n This Getting Started Guide helps you learn the basics of working with the API and shows a few ways you can use it. Check it out, and learn how to:\n <ul>\n <li><a href=\"https://developer.flowcode.com/guides/embed-a-flowcode-generator\">Embed a Flowcode Generator in your application</a></li>\n <li><a href=\"https://developer.flowcode.com/guides/bulk-generate-codes\">Bulk Generate 1:1 Codes</a></li>\n <li><a href=\"https://developer.flowcode.com/guides/ingest-analytics-data\">Ingest Flowcode and Flowpage data into your ETL pipeline</a></li>\n <li><a href=\"https://developer.flowcode.com/guides/flowcode-api-design-guidelines\">Best Practices for Flowcode Design (via API)</a></li>\n </ul>\n <hr>\n\n # [Using the API](#using-the-api)\n\n Flowcode’s REST API is designed to be straightforward to use. You can use the language and platform of your choice to make requests. To get a feel for the API, you can also use a tool like Postman or Insomnia.\n\n ## [API Endpoint](#api-endpoint)\n\n This API uses a base path of https://gateway.flowcode.com\n\n ## [Rate Limiting](#rate-limiting)\n\n The Flowcode API sets a limit of 100 API requests per second. Once this limit is reached the API will start returning errors with HTTP status code 429.\n\n ## [Consistency](#consistency)\n\n A reasonable consistency guarantee can be made between operations via the UI and operations via the API. For example, updates made via the UI should be reflected in subsequent queries via the API,\n and updates made via the API should be reflected on subsequent queries via the UI. A natural limitation here is simultaneous queries and updates such that a query returns before the update to the data has been made,\n but subsequent queries should return the updated data.\n\n ## [Examples](#examples)\n\n Each endpoint in the spec has a request sample that demonstrates a simple example of how to call the endpoint in various programming languages.\n\n ## [Changelog](#changelog)\n\n <a href=\"https://help.flowcode.com/en/articles/7855919-flowcode-api-changelog\">See our up to date changelog here</a>\n\n ## [OpenAPI Spec](#openapi-spec)\n\n In an effort to standardize our API and make it accessible, we offer an OpenAPI 3.0 specification that can be exported into yaml by hitting the `EXPORT` button at the top of this page.\n\n ### [Postman Collection](#postman-collection)\n\n To get started with prototyping the API quickly in Postman, you can use the `EXPORT` button above and import the Flowcode API into a collection. You'll then need to set the appropriate header and environment variables. Also, we recommend you use the 'examples' option for parameter generation in settings when importing the YAML file into Postman.\n\n ## [Status Codes](#status-codes)\n\n The Flowcode API uses the following status codes:\n\n | Code | Meaning |\n |------|---------|\n | 200 | ok -- the request was successful |\n | 201 | created -- the request was successful and an asset was created as a result |\n | 204 | no content -- the request was successful but there was no content to return |\n | 400 | bad request -- the request was invalid |\n | 401 | unauthorized -- authorization credentials were invalid or not provided |\n | 403 | forbidden -- the requesting user does not have enough privileges to perform the action |\n | 404 | not found -- a requested resource was not found |\n | 429 | too many requests -- the request would exceed our defined rate limits |\n | 500 | internal server error -- we had a problem with our server, try again later |\n | 503 | service unavailable -- we are temporarily down for maintenance, try again later |\n \n # [Flowcode Conversion Pixel](#flowcode-conversion-pixel)\n The Flowcode Pixel is the first product of its kind to show a full funnel, offline to online, attribution model. Pixel functionality and analytics will be made available through our Developer Portal soon. In the meantime, check out more information here: https://www.flowcode.com/flowcode-insights.\n \n For more information on setting up the Flowcode Pixel, please visit our help center here: https://help.flowcode.com/en/articles/8258295-how-to-set-up-and-install-the-flowcode-pixel\npaths:\n /v4/codes:\n get: \n tags:\n - Codes\n summary: List codes\n operationId: listCodes\n description: Returns a list of Flowcodes accessible by this user. \n parameters:\n - name: start_date\n in: query\n required: false\n description: Beginning of event date range\n schema:\n type:\n string\n format:\n 'YYYY-MM-DD'\n - name: end_date\n in: query\n required: false\n description: End of event date range (inclusive. Max value today - 1 day)\n schema:\n type:\n string\n format:\n 'YYYY-MM-DD' \n - name: folder_id\n in: query\n required: false\n description: show only codes belonging to the specified folder\n schema:\n type: string\n - name: tag_name\n in: query\n required: false\n description: show only codes with a given tag\n schema:\n type: string\n - name: code_name\n in: query\n required: false\n description: show only codes including a given name\n schema:\n type: string\n - name: is_owner\n in: query\n required: false\n description: show only codes owned by the user\n schema:\n type: boolean\n - name: is_archived\n in: query\n required: false\n description: show only codes that are archived\n schema:\n type: boolean\n - name: org_id\n in: query\n required: false\n description: show codes belonging to the given organization\n schema:\n type: string\n - name: limit\n in: query\n required: false\n description: maximum number of results to return in this query\n schema:\n type: integer\n responses:\n '200':\n $ref: '#/components/responses/ListCodes'\n '401':\n description: Unauthorized. You do not have permission to access the requested\n asset.\n '403':\n description: Forbidden. One or more required headers may not have been provided.\n '404':\n description: A requested asset was not found.\n post:\n tags:\n - Codes\n summary: Create Flowcode\n operationId: createCode\n description: Creates a Flowcode.\n parameters: []\n responses:\n '201':\n $ref: '#/components/responses/CreateCode'\n '400':\n description: Bad request. A required parameter may have been omitted or\n malformed.\n '401':\n description: Unauthorized. You do not have permission to access the requested\n asset.\n '403':\n description: Forbidden. One or more required headers may not have been provided.\n '404':\n description: A requested asset was not found.\n requestBody:\n $ref: '#/components/requestBodies/CreateCode'\n /v4/codes/{code_id}:\n get:\n tags:\n - Codes\n summary: Fetch code\n operationId: getCode\n description: Returns metadata for a specified Flowcode.\n parameters:\n - name: code_id\n in: path\n required: true\n description: id of code to fetch\n schema:\n type: string\n responses:\n '200':\n $ref: '#/components/responses/GetCode'\n '204':\n description: No content.\n '403':\n description: Forbidden. One or more required headers may not have been provided.\n patch:\n tags:\n - Codes\n summary: Update code\n operationId: updateCode\n description: Updates a Flowcode according to specified parameters\n parameters:\n - name: code_id\n in: path\n required: true\n description: id of code to update\n schema:\n type: string\n requestBody:\n $ref: '#/components/requestBodies/UpdateCode'\n responses:\n '200':\n $ref: '#/components/responses/UpdateCode'\n '400':\n description: Bad request. A required parameter may have been omitted or\n malformed.\n '401':\n description: Unauthorized. You do not have permission to access the requested\n asset.\n '403':\n description: Forbidden. One or more required headers may not have been provided.\n '404':\n description: A requested asset was not found.\n /v4/codes/bulk:\n post:\n tags:\n - Bulk Codes\n summary: Create codes in bulk. \n operationId: bulkCreateCodes\n description: |\n Create codes in bulk using a single request.\n Each API request can support up to 3,000 Flowcodes. \n \n ### Guidance on using Studio Config IDs in bulk Flowcode creation: \n When creating Flowcodes in bulk using this endpoint, you have the flexibility to apply a design template called a **studio_config_id** at either or both the base level and individual code level, depending on your specific requirements.\n\n **Base Level Usage:**\n\n - If you wish to apply the same design template to all your Flowcodes, you can simply pass the studio_config_id at the base level.\n \n **Individual Code Level Usage:**\n\n - If you need different design templates for specific codes, you can pass the studio_config_id individually for each code as necessary.\n It's important to note that when you pass a studio_config_id design at the code level, it will take precedence and override any configuration set at the base level.\n requestBody:\n $ref: '#/components/requestBodies/BulkCreateCode'\n responses:\n '201':\n $ref: '#/components/responses/BulkCreateSync'\n '202':\n $ref: '#/components/responses/BulkCreateAsync'\n '400':\n description: Bad request. A required parameter may have been omitted or\n malformed.\n '401':\n description: Unauthorized. You do not have permission to access the requested\n asset.\n '403':\n description: Forbidden. One or more required headers may not have been provided.\n '404':\n description: A requested asset was not found.\n put:\n tags:\n - Bulk Codes\n summary: Update codes in bulk\n operationId: bulkUpdateCodes\n description: Update codes in bulk using a single request.\n requestBody:\n $ref: '#/components/requestBodies/BulkUpdateCode'\n responses:\n '200':\n $ref: '#/components/responses/BulkUpdateSync'\n '202':\n $ref: '#/components/responses/BulkUpdateAsync'\n '400':\n description: Bad request. A required parameter may have been omitted or\n malformed.\n '401':\n description: Unauthorized. You do not have permission to access the requested\n asset.\n '403':\n description: Forbidden. One or more required headers may not have been provided.\n '404':\n description: A requested asset was not found.\n /v4/codes/bulk/csv:\n post:\n tags:\n - Bulk Codes\n summary: Create codes in bulk from CSV\n operationId: bulkCreateCodesFromCsv\n description: \n Create codes in bulk from CSV (comma-separated values) input. \n \n Each API request can support up to 3,000 Flowcodes.\n requestBody:\n $ref: '#/components/requestBodies/BulkCreateCodeFromCsv'\n responses:\n '201':\n $ref: '#/components/responses/BulkCreateSync'\n '202':\n $ref: '#/components/responses/BulkCreateAsync'\n '400':\n description: Bad request. A required parameter may have been omitted or\n malformed.\n '401':\n description: Unauthorized. You do not have permission to access the requested\n asset.\n '403':\n description: Forbidden. One or more required headers may not have been provided.\n '404':\n description: A requested asset was not found.\n /v4/codes/bulk/{task_id}/status:\n get:\n tags:\n - Bulk Codes\n summary: View status of bulk request\n operationId: getBulkRequestStatus\n description: View the status of an asynchronous bulk request.\n parameters:\n - in: path\n name: task_id\n required: true\n schema:\n type: string\n format: uuid\n description: id of the asynchronous task, provided in the response of the bulk request\n responses:\n '200':\n $ref: '#/components/responses/BulkRequestStatus'\n /v3/codes/generator/static:\n get:\n tags:\n - Code Image Generator\n summary: Generate static code image\n operationId: generateStaticImage\n description: Generate a static Flowcode image that scans to a specific destination, specified by url.\n parameters:\n - in: query\n name: url\n required: true\n schema:\n type: string\n description: url to shorten and return flowcode for\n example: https://flowcode.com\n - in: query\n name: code_name\n schema:\n type: string\n description: display name of the code\n example: My Cool Flowcode\n - in: query\n name: image_type\n schema:\n type: string\n enum: [svg, png, tiff, jpg, pdf]\n description: response image type\n example: png\n - in: query\n name: download\n schema:\n type: integer\n format: int32\n minimum: 0\n maximum: 1\n description: if 1, add content-disposition header for attachment\n example: 1\n - in: query\n name: color\n schema:\n type: string\n description: Foreground color in hex format\n example: \"#000000\"\n - in: query\n name: background_color\n schema:\n type: string\n description: background color in hex format\n example: \"#ffffff\"\n - in: query\n name: data_pattern_shape\n schema:\n type: string\n enum: [circle, square, diamond, default]\n description: shape of code pattern\n example: default\n - in: query\n name: logo_image_width\n schema:\n type: integer\n format: int32\n description: numeric width of center logo\n example: 25\n - in: query\n name: logo_image_height\n schema:\n type: integer\n format: int32\n description: numeric height of center logo\n example: 25\n - in: query\n name: logo_image_url\n schema:\n type: string\n description: url of image to use for center logo\n example: https://cdn.flowcode.com/prodassets/Asset_13300x_oci22oT.png\n - in: query\n name: cta_text_top\n schema:\n type: string\n description: text to display at top of rim\n example: SCAN ME\n - in: query\n name: cta_text_bottom\n schema:\n type: string\n description: text to display at bottom of rim\n example: SCAN ME\n responses:\n \"200\":\n $ref: '#/components/responses/StaticCodeImageGenerator'\n \"400\":\n description: Bad Request -- Your request is invalid.\n \"500\":\n description: Internal Server Error -- We had a problem with our server. Try again later.\n \"503\":\n description: Service Unavailable -- We're temporarily offline for maintenance. Please try again later.\n /v3/codes/generator/{code_id}:\n get:\n tags:\n - Code Image Generator\n summary: Generate dynamic code image\n operationId: generateDynamicImage\n description: Generate a dynamic Flowcode image that scans to the short_url of an existing code, specified by code_id.\n parameters:\n - name: code_id\n in: path\n required: true\n schema:\n type: string\n description: id of code for which to generate an image\n - name: image_type\n in: query\n schema:\n type: string\n enum: [svg, png, tiff, jpg, pdf]\n description: response image type\n example: png\n - name: error_correction\n in: query\n schema:\n type: integer\n description: the error correction level for the code\n example: 5\n - name: width\n in: query\n schema:\n type: integer\n description: dimensions of the code image\n example: 1024\n responses:\n \"200\":\n $ref: '#/components/responses/DynamicCodeImageGenerator'\n \"400\":\n description: Bad Request -- Your request is invalid.\n '401':\n description: Unauthorized. You do not have permission to access the requested\n asset.\n \"500\":\n description: Internal Server Error -- We had a problem with our server. Try again later.\n \"503\":\n description: Service Unavailable -- We're temporarily offline for maintenance. Please try again later.\n /v3/code-templates:\n get:\n tags:\n - Code Templates\n summary: List code templates\n operationId: listCodeTemplates\n description: Returns a list of code template configurations accessible by this user. \n parameters:\n - name: is_owner\n in: query\n required: false\n description: show only code templates owned by the user\n schema:\n type: boolean\n - name: is_archived\n in: query\n required: false\n description: show only code templates that are archived\n schema:\n type: boolean\n - name: org_id\n in: query\n required: false\n description: show code templates belonging to the given organization\n schema:\n type: string\n - name: limit\n in: query\n required: false\n description: maximum number of results to return in this query\n schema:\n type: integer\n responses:\n '200':\n $ref: '#/components/responses/ListCodeTemplates'\n '401':\n description: Unauthorized. You do not have permission to access the requested\n asset.\n '403':\n description: Forbidden. One or more required headers may not have been provided.\n '404':\n description: A requested asset was not found.\n /v3/code-templates/{template_id}:\n get:\n tags:\n - Code Templates\n summary: Fetch code template\n operationId: getCodeTemplate\n description: Returns metadata for a specified Flowcode template.\n parameters:\n - name: template_id\n in: path\n required: true\n description: uuid of specific code template\n schema:\n type: string\n format: uuid\n responses:\n '200':\n $ref: '#/components/responses/GetCodeTemplate'\n '401':\n description: Unauthorized. You do not have permission to access the requested\n asset.\n '403':\n description: Forbidden. One or more required headers may not have been provided.\n '404':\n description: A requested asset was not found.\n /v2/flowcode/batch/bulk-campaign:\n get:\n tags:\n - Campaigns (Legacy)\n summary: Fetch campaign\n description: Returns metadata for a specified Flowcode campaign.\n operationId: getCampaign\n parameters:\n - name: client_id\n in: query\n description: client id string the flowcode team has given to you to make api requests\n required: true\n schema:\n type: string\n - name: name\n in: query\n description: Name of campaign\n required: true\n schema:\n type: string\n responses:\n \"200\":\n $ref: '#/components/responses/GetCampaign'\n \"400\":\n description: Bad Request -- Your request is invalid.\n \"500\":\n description: Internal Server Error -- We had a problem with our server. Try again later.\n \"503\":\n description: Service Unavailable -- We're temporarily offline for maintenance. Please try again later.\n post:\n tags:\n - Campaigns (Legacy)\n summary: Create campaign\n operationId: createCampaign\n description: Creates a campaign.\n requestBody:\n $ref: '#/components/requestBodies/CreateCampaign'\n responses:\n \"201\":\n description: Created\n \"400\":\n description: Bad Request -- Your request is invalid.\n \"500\":\n description: Internal Server Error -- We had a problem with our server. Try again later.\n \"503\":\n description: Service Unavailable -- We're temporarily offline for maintenance. Please try again later.\n /v2/flowcode/batch/bulk:\n post:\n tags:\n - Campaigns (Legacy)\n summary: Create flowcodes for campaign\n description: Creates flowcodes for a campaign.\n operationId: createFlowcodesForCampaign\n requestBody:\n $ref: '#/components/requestBodies/CreateFlowcodesForCampaign'\n responses:\n \"201\":\n $ref: '#/components/responses/CreateFlowcodeForCampaign'\n \"400\":\n description: Bad Request -- Your request is invalid.\n \"500\":\n description: Internal Server Error -- We had a problem with our server. Try again later.\n \"503\":\n description: Service Unavailable -- We're temporarily offline for maintenance. Please try again later.\n put:\n tags:\n - Campaigns (Legacy)\n summary: Update flowcodes for campaign\n description: Updates flowcodes for a campaign.\n operationId: updateFlowcodes\n requestBody:\n $ref: '#/components/requestBodies/UpdateFlowcodesForCampaign'\n responses:\n \"200\":\n description: Returns a status of 200 on success\n \"400\":\n description: Bad Request -- Your request is invalid.\n \"500\":\n description: Internal Server Error -- We had a problem with our server. Try again later.\n \"503\":\n description: Service Unavailable -- We're temporarily offline for maintenance. Please try again later.\n /analytics/v2/events/flowcode:\n get:\n tags:\n - Analytics | Flowcode Events\n summary: Get events\n operationId: getFlowcodeEvents\n description: Get events for all of your flowcodes.\n parameters:\n - $ref: '#/components/parameters/StartDate'\n - $ref: '#/components/parameters/EndDate'\n - $ref: '#/components/parameters/PageSize'\n - $ref: '#/components/parameters/PageNum'\n - $ref: '#/components/parameters/Timezone'\n responses:\n '200':\n $ref: '#/components/responses/FlowcodeEvents'\n \"400\":\n description: Bad Request -- Your request is invalid.\n \"500\":\n description: Internal Server Error -- We had a problem with our server. Try again later.\n \"503\":\n description: Service Unavailable -- We're temporarily offline for maintenance. Please try again later.\n /analytics/v2/events/flowcode/asset/{id}:\n get:\n tags:\n - Analytics | Flowcode Events\n summary: Get events for batch\n operationId: getFlowcodeEventsForBatch\n description: Get events for a batch. All codes in a batch have the same destination.\n parameters:\n - $ref: '#/components/parameters/BatchId'\n - $ref: '#/components/parameters/StartDate'\n - $ref: '#/components/parameters/EndDate'\n - $ref: '#/components/parameters/PageSize'\n - $ref: '#/components/parameters/PageNum'\n - $ref: '#/components/parameters/Timezone'\n responses:\n '200':\n $ref: '#/components/responses/FlowcodeEvents'\n \"400\":\n description: Bad Request -- Your request is invalid.\n \"500\":\n description: Internal Server Error -- We had a problem with our server. Try again later.\n \"503\":\n description: Service Unavailable -- We're temporarily offline for maintenance. Please try again later.\n /analytics/v2/events/flowcode/folder/{id}:\n get:\n tags:\n - Analytics | Flowcode Events\n summary: Get events for codes in folder\n operationId: getFlowcodeEventsForFolder\n description: Get events for flowcodes scoped to a specific folder.\n parameters:\n - $ref: '#/components/parameters/FolderId'\n - $ref: '#/components/parameters/StartDate'\n - $ref: '#/components/parameters/EndDate'\n - $ref: '#/components/parameters/PageSize'\n - $ref: '#/components/parameters/PageNum'\n - $ref: '#/components/parameters/Timezone'\n responses:\n '200':\n $ref: '#/components/responses/FlowcodeEvents'\n \"400\":\n description: Bad Request -- Your request is invalid.\n \"500\":\n description: Internal Server Error -- We had a problem with our server. Try again later.\n \"503\":\n description: Service Unavailable -- We're temporarily offline for maintenance. Please try again later.\n /analytics/v2/counts/flowcode:\n get:\n tags:\n - Analytics | Flowcode Event Summary\n summary: Get event summary\n operationId: getFlowcodeEventSummary\n description: Get event summary across your flowcodes.\n parameters:\n - $ref: '#/components/parameters/StartDate'\n - $ref: '#/components/parameters/EndDate'\n - $ref: '#/components/parameters/TimeInterval'\n - $ref: '#/components/parameters/Timezone'\n responses:\n '200':\n $ref: '#/components/responses/FlowcodeEventSummary'\n \"400\":\n description: Bad Request -- Your request is invalid.\n \"500\":\n description: Internal Server Error -- We had a problem with our server. Try again later.\n \"503\":\n description: Service Unavailable -- We're temporarily offline for maintenance. Please try again later.\n /analytics/v2/counts/flowcode/asset/{id}:\n get:\n tags:\n - Analytics | Flowcode Event Summary\n summary: Get event summary for batch\n operationId: getFlowcodeEventSummaryForBatch\n description: Get event summary for a batch. All codes in a batch have the same destination.\n parameters:\n - $ref: '#/components/parameters/BatchId'\n - $ref: '#/components/parameters/StartDate'\n - $ref: '#/components/parameters/EndDate'\n - $ref: '#/components/parameters/TimeInterval'\n - $ref: '#/components/parameters/Timezone'\n responses:\n '200':\n $ref: '#/components/responses/FlowcodeEventSummary'\n \"400\":\n description: Bad Request -- Your request is invalid.\n \"500\":\n description: Internal Server Error -- We had a problem with our server. Try again later.\n \"503\":\n description: Service Unavailable -- We're temporarily offline for maintenance. Please try again later.\n /analytics/v2/counts/flowcode/folder/{id}:\n get:\n tags:\n - Analytics | Flowcode Event Summary\n summary: Get event summary for codes in folder\n operationId: getFlowcodeEventSummaryForFolder\n description: Get event summary across your flowcodes, scoped to a specific folder.\n parameters:\n - $ref: '#/components/parameters/FolderId'\n - $ref: '#/components/parameters/StartDate'\n - $ref: '#/components/parameters/EndDate'\n - $ref: '#/components/parameters/TimeInterval'\n - $ref: '#/components/parameters/Timezone'\n responses:\n '200':\n $ref: '#/components/responses/FlowcodeEventSummary'\n \"400\":\n description: Bad Request -- Your request is invalid.\n \"500\":\n description: Internal Server Error -- We had a problem with our server. Try again later.\n \"503\":\n description: Service Unavailable -- We're temporarily offline for maintenance. Please try again later.\n /analytics/v2/counts/flowcode/flowcode/{id}:\n get:\n tags:\n - Analytics | Flowcode Event Summary\n summary: Get event summary for specific flowcode\n operationId: getFlowcodeEventSummaryForFlowcode\n description: Get event summary for specific flowcode.\n parameters:\n - $ref: '#/components/parameters/FlowcodeId'\n - $ref: '#/components/parameters/StartDate'\n - $ref: '#/components/parameters/EndDate'\n - $ref: '#/components/parameters/TimeInterval'\n - $ref: '#/components/parameters/Timezone'\n responses:\n '200':\n $ref: '#/components/responses/FlowcodeEventSummary'\n \"400\":\n description: Bad Request -- Your request is invalid.\n \"500\":\n description: Internal Server Error -- We had a problem with our server. Try again later.\n \"503\":\n description: Service Unavailable -- We're temporarily offline for maintenance. Please try again later.\n /analytics/v2/events/flowpage:\n get:\n tags:\n - Analytics | Flowpage Events\n summary: Get events\n operationId: getFlowpageEvents\n description: Get events for all of your flowpages.\n parameters:\n - $ref: '#/components/parameters/StartDate'\n - $ref: '#/components/parameters/EndDate'\n - $ref: '#/components/parameters/PageSize'\n - $ref: '#/components/parameters/PageNum'\n - $ref: '#/components/parameters/Timezone'\n responses:\n '200':\n $ref: '#/components/responses/FlowpageEvents'\n \"400\":\n description: Bad Request -- Your request is invalid.\n \"500\":\n description: Internal Server Error -- We had a problem with our server. Try again later.\n \"503\":\n description: Service Unavailable -- We're temporarily offline for maintenance. Please try again later.\n /analytics/v2/events/flowpage/page/{id}:\n get:\n tags:\n - Analytics | Flowpage Events\n summary: Get events for specific page\n operationId: getFlowpageEventsForPage\n description: Get events for a specific flowpage.\n parameters:\n - $ref: '#/components/parameters/PageId'\n - $ref: '#/components/parameters/StartDate'\n - $ref: '#/components/parameters/EndDate'\n - $ref: '#/components/parameters/PageSize'\n - $ref: '#/components/parameters/PageNum'\n - $ref: '#/components/parameters/Timezone'\n responses:\n '200':\n $ref: '#/components/responses/FlowpageEvents'\n \"400\":\n description: Bad Request -- Your request is invalid.\n \"500\":\n description: Internal Server Error -- We had a problem with our server. Try again later.\n \"503\":\n description: Service Unavailable -- We're temporarily offline for maintenance. Please try again later.\n /analytics/v2/counts/flowpage:\n get:\n tags:\n - Analytics | Flowpage Event Summary\n summary: Get event summary\n operationId: getFlowpageEventSummary\n description: Get event summary across your flowpages.\n parameters:\n - $ref: '#/components/parameters/StartDate'\n - $ref: '#/components/parameters/EndDate'\n - $ref: '#/components/parameters/TimeInterval'\n - $ref: '#/components/parameters/Timezone'\n responses:\n '200':\n $ref: '#/components/responses/FlowpageEventSummary'\n \"400\":\n description: Bad Request -- Your request is invalid.\n \"500\":\n description: Internal Server Error -- We had a problem with our server. Try again later.\n \"503\":\n description: Service Unavailable -- We're temporarily offline for maintenance. Please try again later.\n /analytics/v2/counts/flowpage/page/{id}:\n get:\n tags:\n - Analytics | Flowpage Event Summary\n summary: Get event summary for specific page\n operationId: getFlowpageEventSummaryForPage\n description: Get event summary for a specific flowpage.\n parameters:\n - $ref: '#/components/parameters/PageId'\n - $ref: '#/components/parameters/StartDate'\n - $ref: '#/components/parameters/EndDate'\n - $ref: '#/components/parameters/TimeInterval'\n - $ref: '#/components/parameters/Timezone'\n responses:\n '200':\n $ref: '#/components/responses/FlowpageEventSummary'\n \"400\":\n description: Bad Request -- Your request is invalid.\n \"500\":\n description: Internal Server Error -- We had a problem with our server. Try again later.\n \"503\":\n description: Service Unavailable -- We're temporarily offline for maintenance. Please try again later.\n /analytics/v2/event-types:\n get:\n tags:\n - Analytics | Event Types\n summary: Get event types\n operationId: getEventTypes\n description: Get all event types.\n responses:\n '200':\n $ref: '#/components/responses/EventTypes'\n \"400\":\n description: Bad Request -- Your request is invalid.\n \"500\":\n description: Internal Server Error -- We had a problem with our server. Try again later.\n \"503\":\n description: Service Unavailable -- We're temporarily offline for maintenance. Please try again later.\n /analytics/v2/operating-systems:\n get:\n tags:\n - Analytics | Operating Systems\n summary: Get operating systems\n operationId: getOperatingSystems\n description: Get all operating systems.\n responses:\n '200':\n $ref: '#/components/responses/OperatingSystems'\n \"400\":\n description: Bad Request -- Your request is invalid.\n \"500\":\n description: Internal Server Error -- We had a problem with our server. Try again later.\n \"503\":\n description: Service Unavailable -- We're temporarily offline for maintenance. Please try again later.\n /analytics/v2/operating-systems/{id}:\n get:\n tags:\n - Analytics | Operating Systems\n summary: Get operating system by id\n operationId: getOperatingSystemById\n description: Get an operating system by its id.\n parameters:\n - name: id\n in: path\n required: true\n description: Integer id of operating system to be retrieved\n schema:\n type: integer\n responses:\n '200':\n $ref: '#/components/responses/OperatingSystems'\n \"400\":\n description: Bad Request -- Your request is invalid.\n \"500\":\n description: Internal Server Error -- We had a problem with our server. Try again later.\n \"503\":\n description: Service Unavailable -- We're temporarily offline for maintenance. Please try again later.\n /analytics/v2/products:\n get:\n tags:\n - Analytics | Products\n summary: Get products\n operationId: getProducts\n description: Get all products.\n responses:\n '200':\n $ref: '#/components/responses/Products'\n \"400\":\n description: Bad Request -- Your request is invalid.\n \"500\":\n description: Internal Server Error -- We had a problem with our server. Try again later.\n \"503\":\n description: Service Unavailable -- We're temporarily offline for maintenance. Please try again later.\n /analytics/v2/products/{id}:\n get:\n tags:\n - Analytics | Products\n summary: Get product by id\n operationId: getProductById\n description: Get a product by its id.\n parameters:\n - name: id\n in: path\n required: true\n description: Integer id of product to be retrieved\n schema:\n type: integer\n responses:\n '200':\n $ref: '#/components/responses/Products'\n \"400\":\n description: Bad Request -- Your request is invalid.\n \"500\":\n description: Internal Server Error -- We had a problem with our server. Try again later.\n \"503\":\n description: Service Unavailable -- We're temporarily offline for maintenance. Please try again later.\n /analytics/v2/contacts:\n get:\n tags:\n - Analytics | Contacts\n summary: Get contacts\n operationId: getContacts\n description: Get contact info submitted on flowpages for a specific date range.\n parameters:\n - $ref: '#/components/parameters/StartDate'\n - $ref: '#/components/parameters/EndDate'\n - $ref: '#/components/parameters/PageSize'\n - $ref: '#/components/parameters/PageNum'\n - $ref: '#/components/parameters/includeShared'\n responses:\n '200':\n $ref: '#/components/responses/Contacts'\n \"400\":\n description: Bad Request -- Your request is invalid.\n \"500\":\n description: Internal Server Error -- We had a problem with our server. Try again later.\n \"503\":\n description: Service Unavailable -- We're temporarily offline for maintenance. Please try again later.\nservers:\n - url: https://gateway.flowcode.com\n description: Production\ncomponents:\n securitySchemes:\n ApiKeyAuth: # arbitrary name for the security scheme\n type: apiKey\n in: header # can be \"header\", \"query\" or \"cookie\"\n name: apikey # name of the header, query parameter or cookie\n parameters:\n StartDate:\n name: start_date\n in: query\n required: true\n description: Beginning of event date range\n schema:\n type:\n string\n format:\n 'YYYY-MM-DD'\n EndDate:\n name: end_date\n in: query\n required: true\n description: End of event date range (inclusive. Max value today - 1 day)\n schema:\n type:\n string\n format:\n 'YYYY-MM-DD'\n BatchId:\n name: id\n in: path\n required: true\n description: Alphanumeric identifier of the batch\n schema:\n type:\n string\n format:\n '[A-Za-z0-9]'\n FlowcodeId:\n name: id\n in: path\n required: True\n description: Alphanumeric identifier of the flowcode\n schema:\n type: string\n format: '[A-Za-z0-9]'\n FolderId:\n name: id\n in: path\n required: true\n description: Numeric identifier of the folder\n schema:\n type:\n number\n PageId:\n name: id\n in: path\n required: true\n description: UUID of page\n schema:\n type:\n string\n format:\n '[a-fA-F0-9-]'\n PageSize:\n name: page_size\n in: query\n required: false\n description: The maximum number of elements to be returned, <= 1000. Larger values will be set to 1000\n schema:\n type:\n number\n PageNum:\n name: page_num\n in: query\n required: false\n description: Page to return results for, zero-indexed. A page_num higher than the page count will return 0 results\n schema:\n type:\n number\n TimeInterval:\n name: interval\n in: query\n required: true\n description: The size of the group by which the data will be counted\n schema:\n type:\n string\n enum:\n - hourly\n - daily\n - weekly\n - monthly\n Timezone:\n name: timezone\n in: query\n required: false\n description: Set the timezone of the returned event_times. The full list of supported timezones matches the TZ identifier list here https://en.wikipedia.org/wiki/List_of_tz_database_time_zones\n example: America/New_York\n schema:\n type:\n string\n default: If none provided, default to America/New_York\n includeShared:\n name: includeShared\n in: query\n required: false\n description: 'Include contacts from Flowpages shared with you'\n schema:\n type:\n boolean\n requestBodies:\n CreateCode:\n description: The parameters that determine the functionality and appearance\n of the code\n content:\n application/json:\n schema:\n type: object\n required: \n - destination\n properties:\n destination:\n $ref: '#/components/schemas/ScanDestination'\n code_name:\n type: string\n description: display name of the code\n example: My Cool Flowcode\n rules:\n $ref: '#/components/schemas/SmartRule'\n interstitials:\n type: array\n description: interstitial objects to apply to the code\n items:\n $ref: '#/components/schemas/Interstitial'\n folder_id:\n type: integer\n description: numeric identifier of the folder that should contain the code\n example: 1234\n studio_config_id:\n type: string\n description: uuid of a studio configuration governing the appearance of the code\n format: uuid\n redirect_subdomain:\n type: string\n description: subdomain to use as the base of the code's resulting short_url, which is shown upon scanning the code\n default: https://flowcode.com/p/\n tags:\n type: array\n description: free form metadata tags that can be used for organizing, searching, and filtering codes\n items:\n type: string\n example: [\"Flowcode\", \"API\"]\n download:\n type: boolean\n description: if true will return the downloaded code image\n example: false\n image_type:\n type: string\n enum: [svg, png, tiff, jpg, pdf]\n description: type of code image to download\n example: png\n customization_options:\n type: object\n description: parameters that can set certain design elements of the code (cannot be combined with studio_config_id)\n properties:\n color:\n type: string\n format: '#ABCDEF'\n description: code foreground color (must be in hexadecimal form)\n example: '#000000'\n background_color:\n type: string\n format: '#ABCDEF'\n description: code background color (must be in hexadecimal form)\n example: '#FFFFFF'\n logo_image_url:\n type: string\n format: url\n description: URL of logo image to use in center of the code\n example: https://google.com/images/example.png\n logo_image_height:\n type: integer\n description: numeric height of logo image\n example: 25\n logo_image_width:\n type: integer\n description: numeric width of logo image\n example: 25\n data_pattern_shape:\n type: string\n enum: [circle, square, diamond, default]\n cta_text_top:\n type: string\n description: call to action text at top of the code (max of 37 characters)\n example: SCAN ME\n cta_text_bottom:\n type: string\n description: call to action text at bottom of the code (max of 37 characters)\n example: SCAN ME\n example:\n destination: \n destination_type: URL\n redirect_value: \n url: https://www.flowcode.com/page/devapi\n code_name: My Cool Flowcode\n redirect_subdomain: https://flowcode.com/p/\n download: false \n UpdateCode:\n description: The parameters that determine how to update the code\n content:\n application/json:\n schema:\n type: object\n required:\n - destination\n properties:\n destination:\n $ref: '#/components/schemas/ScanDestination'\n code_name:\n type: string\n description: display name of the code\n example: My Cool Flowcode\n rules:\n $ref: '#/components/schemas/SmartRule'\n folder_id:\n type: integer\n description: numeric identifier of the folder that should contain the code\n example: 1234\n redirect_subdomain:\n type: string\n description: subdomain to use as the base of the code's resulting short_url, which is shown upon scanning the code\n default: https://flowcode.com/p/\n studio_config_id:\n type: string\n description: uuid of a studio configuration governing the appearance of the code\n format: uuid\n example:\n destination: \n destination_type: URL\n redirect_value: \n url: https://www.flowcode.com/page/devapi\n BulkCreateCode:\n description: The parameters that determine the functionality and appearance of the codes\n content:\n application/json:\n schema:\n type: object\n required:\n - codes\n properties:\n codes:\n type: array\n items:\n type: object\n required: \n - destination\n properties:\n destination:\n $ref: '#/components/schemas/ScanDestination'\n code_name:\n type: string\n description: display name of the code\n example: My Cool Flowcode\n rules:\n $ref: '#/components/schemas/SmartRule'\n interstitials:\n type: array\n description: interstitial objects to apply to the code\n items:\n $ref: '#/components/schemas/Interstitial'\n studio_config_id:\n type: string\n description: uuid of a studio configuration governing the appearance of the code\n format: uuid\n redirect_subdomain:\n type: string\n description: subdomain to use as the base of the code's resulting short_url, which is shown upon scanning the code\n default: https://flowcode.com/p/\n tags:\n type: array\n description: free form metadata tags that can be used for organizing, searching, and filtering codes\n items:\n type: string\n example: [\"Flowcode\", \"API\"]\n folder_id:\n type: integer\n description: numeric identifier of the folder that should contain the codes\n example: 1234\n folder_name:\n type: string\n description: name of folder to create and place codes into\n example: My New Folder\n folder_path:\n type: string\n description: hierarchical path to the parent of the new folder - this field will be used in conjunction with folder_name to create the new folder at that location (e.g. if folder_path is \"root_folder/sub_folder\" and folder_name is \"another_sub_folder\", the result will be \"root_folder/sub_folder/another_sub_folder\")\n example: parent_folder/child_folder\n studio_config_id:\n type: string\n description: uuid of a studio configuration governing the appearance of all codes in the request\n format: uuid\n example:\n codes:\n - destination:\n destination_type: URL\n redirect_value:\n url: https://www.flowcode.com/page/devapi\n code_name: My Cool Flowcode 1\n - destination:\n destination_type: URL\n redirect_value:\n url: https://www.flowcode.com/page/devapi-2\n code_name: My Cool Flowcode 2\n folder_name: My Cool Flowcodes\n BulkUpdateCode:\n description: The parameters that determine how to update the code\n content:\n application/json:\n schema:\n type: object\n required:\n - codes\n properties:\n codes:\n type: array\n items:\n type: object\n required:\n - code_id\n - destination\n properties:\n code_id:\n type: string\n description: id of code to update\n destination:\n $ref: '#/components/schemas/ScanDestination'\n folder_id:\n type: integer\n description: numeric identifier of the folder that should contain the codes\n example: 1234\n folder_name:\n type: string\n description: name of folder to move codes into\n example: My New Folder\n studio_config_id:\n type: string\n description: uuid of a studio configuration governing the appearance of all codes in the request\n format: uuid\n tags:\n type: array\n description: free form metadata tags that can be used for organizing, searching, and filtering codes\n items:\n type: string\n example: [\"Flowcode\", \"API\"]\n example:\n codes:\n - destination:\n destination_type: URL\n redirect_value:\n url: https://www.flowcode.com/page/devapi\n code_id: \"1234\"\n - destination:\n destination_type: URL\n redirect_value:\n url: https://www.flowcode.com/page/devapi-2 \n code_id: \"1234\"\n BulkCreateCodeFromCsv:\n description: The parameters that determine the functionality and appearance of the codes\n content:\n multipart/form-data:\n schema:\n type: object\n required:\n - csv_file\n properties:\n csv_file:\n type: string\n format: binary\n example: codes.csv\n folder_id:\n type: integer\n description: numeric identifier of the folder that should contain the codes\n example: 1234\n folder_name:\n type: string\n description: name of folder to create and place codes into\n example: My New Folder\n studio_config_id:\n type: string\n description: uuid of a studio configuration governing the appearance of all codes in the request\n format: uuid\n redirect_subdomain:\n type: string\n description: subdomain to use as the base of the code's resulting short_url, which is shown upon scanning the code\n default: https://flowcode.com/p/\n CreateCampaign:\n content:\n application/json:\n schema:\n $ref: \"#/components/schemas/Campaign\"\n description: Flowcode Campaign to be created\n required: true\n CreateFlowcodesForCampaign:\n content:\n application/json:\n schema:\n type: object\n required:\n - client_id\n - campaign_name\n - urls\n properties:\n client_id:\n type: string\n description: client id string the flowcode team has given to you to make api requests\n format: uuid\n campaign_name:\n type: string\n description: Name of campaign\n example: My Campaign\n urls:\n type: array\n items:\n $ref: '#/components/schemas/Url'\n description: Array of URL Objects\n smart_rules:\n type: object\n description: Smart Rules are a feature that enable scanners to be conditionally redirected based on their device type, time of day, day of week or location.\n required:\n - rules\n - time_zone\n properties:\n rules:\n type: array\n items:\n type: object\n description: A logical set of conditions that, when met, result in a code scanning to the specified destination rather than its default destination.\n required:\n - url\n properties:\n url:\n type: string\n description: Desired destination URL\n example: https://google.com\n days:\n type: array\n description: Optional array of numbers for days rule should apply to (0 = Sunday, 6 = Saturday)\n example: [0,1,2]\n items:\n type: integer\n enum: [0,1,2,3,4,5,6]\n start_time:\n type: string\n description: Optional HH:MM in 24 hour clock for start time rule should apply to\n pattern: ^(0[0-9]|1[0-9]|2[0-3]):[0-5][0-9]$\n example: \"14:45\"\n end_time:\n type: string\n description: Optional HH:MM in 24 hour clock for end time rule should apply to\n pattern: ^(0[0-9]|1[0-9]|2[0-3]):[0-5][0-9]$\n example: \"14:45\"\n device_type:\n type: string\n description: Type of scanning device the rule should apply to\n enum: [ANDROID, DESKTOP, IOS]\n region:\n type: string\n description: Geographic region of the scanner\n enum: [South, Midwest, West, Northeast]\n state:\n type: string\n example: NY\n description: State of the scanner\n county:\n type: string\n example: New York County\n description: County of the scanner\n zip:\n type: string\n example: \"10013\"\n description: Zip code of the scanner\n distance:\n type: integer\n description: Distance from a specified location\n minimum: 0\n example: 10\n distance_unit:\n type: string\n description: Unit of distance from specified location\n enum: [mi, km, m]\n from_lat:\n type: number\n description: Latitude of specified location\n format: float\n minimum: -90.0\n maximum: 90.0\n example: 40.75\n from_lng:\n type: number\n description: Longitude of specified location\n format: float\n minimum: -180.0\n maximum: 180.0\n example: -73.98\n time_zone:\n type: string\n description: Time zone for rules. SCANNER=use scanner's timezone\n enum: [SCANNER, Etc/GMT+12, Etc/GMT+11, Etc/GMT+10, Etc/GMT+9, America/Los_Angeles, America/Denver, America/Chicago, America/New_York, Etc/GMT+4, Etc/GMT+3, Etc/GMT+2, Etc/GMT+1, Europe/London, Europe/Berlin, Etc/GMT-2, Etc/GMT-3, Etc/GMT-4, Etc/GMT-5, Asia/Colombo, Asia/Kathmandu, Etc/GMT-6, Indian/Cocos, Etc/GMT-7, Etc/GMT-8, Etc/GMT-9, Pacific/Marquesas, Etc/GMT-10, Etc/GMT-11, Etc/GMT-12, Etc/GMT-13]\n interstitials:\n type: array\n items:\n $ref: '#/components/schemas/Interstitial'\n description: Array of optional Interstitial Objects to use for all urls (this can also be placed on individual URL objects instead)\n UpdateFlowcodesForCampaign:\n content:\n application/json:\n schema:\n type: object\n required:\n - client_id\n - campaign_name\n - urls\n properties:\n client_id:\n type: string\n format: uuid\n description: client id string the flowcode team has given to you to make api requests\n campaign_name:\n type: string\n description: Name of campaign\n example: My Campaign\n urls:\n type: array\n items:\n required:\n - url_type\n - url\n - short_url\n properties:\n url_type:\n type: string\n description: Type of URL (e.g. URL)\n example: URL\n url:\n type: string\n format: url\n description: URL shorturl should redirect to. The URL should be properly url encoded\n example: https://example.com\n shorturl:\n type: string\n format: url\n description: shorturl from create call\n example: https://flowcode.com/p/aBcDe1234\n campaign_name:\n type: string\n description: Name of campaign (optional) if not same as campaign_name passed at top level\n example: My Campaign\n responses:\n ListCodes:\n description: OK\n content:\n application/json:\n schema:\n type: object\n properties:\n next:\n type: string\n description: URL to request the next page of results\n example: https://gateway.flowcode.com/v4/codes?cursor=cD0yMDIzLTAzLTA5KzA1JTNBMTIlM0EyNi4xOTQyNTclMkIwMCUzQTAw&limit=10\n previous:\n type: string\n description: URL to request the previous page of results\n example: https://gateway.flowcode.com/v4/codes?cursor=cj0xJnA9MjAyMy0wMy0wOSswNSUzQTEyJTNBMjMuODczNzk5JTJCMDAlM0EwMA%3D%3D&limit=10\n results:\n type: array\n items:\n $ref: '#/components/schemas/Code'\n CreateCode:\n description: The Flowcode was successfully created.\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/Code'\n GetCode:\n description: OK\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/Code'\n UpdateCode:\n description: The Flowcode was successfully updated.\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/Code'\n BulkCreateSync:\n description: The Flowcodes were successfully created.\n content:\n application/json:\n schema:\n type: object\n properties:\n num_codes:\n type: integer\n description: number of codes created in the request\n example: 50\n folder:\n type: object\n description: folder containing the codes\n properties:\n folder_id:\n type: string\n description: numeric identifier of the folder\n example: 1234\n folder_name:\n type: string\n description: name of the folder\n example: child_folder\n folder_path:\n type: string\n description: hierarchical path to the folder, including the folder itself and its ancestors\n example: parent_folder/child_folder\n waited_for_codes:\n type: boolean\n description: boolean representing whether the codes were created synchronously or asynchronously\n example: True\n BulkCreateAsync:\n description: The request was accepted and the Flowcodes are being created.\n content:\n application/json:\n schema:\n type: object\n properties:\n num_codes:\n type: integer\n description: number of codes to be created in the request\n example: 5000\n folder:\n type: object\n description: folder containing the codes\n properties:\n folder_id:\n type: string\n description: numeric identifier of the folder\n example: 1234\n folder_name:\n type: string\n description: name of the folder\n example: child_folder\n folder_path:\n type: string\n description: hierarchical path to the folder, including the folder itself and its ancestors\n example: parent_folder/child_folder\n waited_for_codes:\n type: boolean\n description: boolean representing whether the codes were created synchronously or asynchronously\n example: False\n task_id:\n type: string\n format: uuid\n description: unique identifier of the asynchronous task that may be used to query the status of the bulk request\n BulkUpdateSync:\n description: The Flowcodes were successfully updated.\n content:\n application/json:\n schema:\n type: object\n properties:\n num_codes:\n type: integer\n description: number of codes updated in the request\n example: 50\n waited_for_codes:\n type: boolean\n description: boolean representing whether the codes were updated synchronously or asynchronously\n example: True\n BulkUpdateAsync:\n description: The request was accepted and the Flowcodes are being updated.\n content:\n application/json:\n schema:\n type: object\n properties:\n num_codes:\n type: integer\n description: number of codes to be updated in the request\n example: 5000\n waited_for_codes:\n type: boolean\n description: boolean representing whether the codes were updated synchronously or asynchronously\n example: False\n task_id:\n type: string\n format: uuid\n description: unique identifier of the asynchronous task that may be used to query the status of the bulk request\n BulkRequestStatus:\n description: Retrieved the status of the bulk request\n content:\n application/json:\n schema:\n type: object\n properties:\n status:\n type: string\n description: the status of the asynchronous bulk request\n enum:\n - FAILURE\n - PENDING\n - RECEIVED\n - RETRY\n - STARTED\n - SUCCESS\n example: STARTED\n message:\n type: string\n description: optional error details included if the status is FAILURE or RETRY\n example: Duplicate code named 'My Cool Flowcode' in folder 1234\n StaticCodeImageGenerator:\n description: Use the URL to view/download the Flowcode image\n content:\n application/json:\n schema:\n type: object\n properties:\n url:\n type: string\n format: url\n example: https://generator.flowcode.com/v1/flowcode?data=https://google.com&width=1024\n DynamicCodeImageGenerator:\n description: Use the URL to view/download the Flowcode image\n content:\n application/json:\n schema:\n type: object\n properties:\n url:\n type: string\n format: url\n example: https://generator.flowcode.com/v1/flowcode?data=https://flowcode.com/p/aBcDe1234&width=1024\n ListCodeTemplates:\n description: 'OK'\n content:\n application/json:\n schema:\n type: object\n properties:\n next:\n type: string\n description: URL to request the next page of results\n example: https://gateway.flowcode.com/v3/code-templates?cursor=cD0yMDIzLTAzLTA5KzA1JTNBMTIlM0EyNi4xOTQyNTclMkIwMCUzQTAw&limit=10\n previous:\n type: string\n description: URL to request the previous page of results\n example: https://gateway.flowcode.com/v3/code-templates?cursor=cj0xJnA9MjAyMy0wMy0wOSswNSUzQTEyJTNBMjMuODczNzk5JTJCMDAlM0EwMA%3D%3D&limit=10\n results:\n type: array\n items:\n $ref: '#/components/schemas/CodeTemplate'\n GetCodeTemplate:\n description: 'OK'\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/CodeTemplate'\n GetCampaign:\n description: get campaign response\n content:\n application/json:\n schema:\n type: object\n properties:\n image_types:\n type: array\n items:\n $ref: '#/components/schemas/ImageType'\n display_name:\n type: string\n description: display name of the campaign\n example: My Campaign\n reserved_urls_unique:\n type: boolean\n description: True if each URL in the campaign in unique, false if there will be one URL with many flowcodes pointing to it\n example: true\n CreateFlowcodeForCampaign:\n description: create flowcode for campaign response\n content:\n application/json:\n schema:\n type: object\n properties:\n id:\n type: string\n description: ID passed in the request\n example: id1\n shorturl:\n type: string\n description: URL that redirects to the final scan destination of the code\n example: https://flowcode.com/p/aBcDe1234\n images:\n type: array\n items:\n properties:\n name:\n type: string\n description: Name given to the image type\n example: image1\n url:\n type: string\n format: url\n description: Generator URL which can be used to download the code image\n example: https://generator.flowcode.com/v1/flowcode?id=12345678&campaign_id=dddddddd-dddd-dddd-dddd-dddddddddddd&type=image1\n FlowcodeEvents:\n description: OK\n content:\n application/json:\n schema:\n type: object\n properties:\n page:\n type: integer\n description: Current results page (zero indexed)\n example: 0\n total_pages:\n type: integer\n description: Total number of pages for requested parameters\n example: 1\n total_count:\n type: integer\n description: Total number of events for requested parameters\n example: 25\n events:\n type: array\n items:\n $ref: '#/components/schemas/ScanEvent'\n FlowcodeEventSummary:\n description: OK\n content:\n application/json:\n schema:\n type: object\n properties:\n asset_id:\n type: string\n description: The unique identifier for the batch containing the flowcode. All codes in a batch have the same destination\n example: aBcDe\n nickname:\n type: string\n description: The name assigned to the batch\n example: My Cool Flowcode\n counts:\n type: array\n items:\n $ref: '#/components/schemas/ScanEventSummary'\n FlowpageEvents:\n description: OK\n content:\n application/json:\n schema:\n type: object\n properties:\n page:\n type: integer\n description: Current results page (zero indexed)\n example: 0\n total_pages:\n type: integer\n description: Total number of pages for requested parameters\n example: 1\n total_count:\n type: integer\n description: Total number of events for requested parameters\n example: 25\n events:\n type: array\n items:\n $ref: '#/components/schemas/PageEvent'\n FlowpageEventSummary:\n description: OK\n content:\n application/json:\n schema:\n type: object\n properties:\n page_id:\n type: string\n description: The unique identifier for the page on which the event was triggered\n format: uuid\n page_title:\n type: string\n description: The title assigned to the page at page creation\n example: My Cool Flowpage\n counts:\n type: array\n items:\n $ref: '#/components/schemas/PageEventSummary'\n EventTypes:\n description: OK\n content:\n application/json:\n schema:\n type: array\n items:\n $ref: '#/components/schemas/EventType'\n OperatingSystems:\n description: OK\n content:\n application/json:\n schema:\n type: array\n items:\n $ref: '#/components/schemas/OperatingSystem'\n Products:\n description: OK\n content:\n application/json:\n schema:\n type: array\n items:\n $ref: '#/components/schemas/Product'\n Contacts:\n description: OK\n content:\n application/json:\n schema:\n type: object\n properties:\n page:\n type: integer\n description: Current results page (zero indexed)\n example: 0\n totalPages:\n type: integer\n description: Total number of pages for requested parameters\n example: 1\n totalCount:\n type: integer\n description: Total number of results for requested parameters\n example: 25\n pageIdToContacts:\n type: array\n items:\n properties:\n pageId:\n type: string\n description: The unique identifier of the page where the contact info was collected\n format: uuid \n contacts:\n type: array\n items:\n $ref: '#/components/schemas/Contact'\n schemas:\n Code:\n type: object\n properties:\n code_id:\n type: string\n description: alphanumeric identifier of the code\n example: abcde\n redirect_subdomain:\n type: string\n description: subdomain of the code's short_url\n example: https://qr.example.com/\n short_url:\n type: string\n description: the url of the code that leads to its scan destination, and is displayed when the code is scanned\n example: https://qr.example/com/abcde1234\n modified_at:\n type: string\n description: timestamp of when the code was last modified\n example: \"2023-01-01T12:00:00.000000Z\"\n is_scan:\n type: boolean\n description: is the code scannable\n example: true\n code_name:\n type: string\n description: display name of the code\n example: My Cool Flowcode\n archive_reason:\n type: string\n description: nullable reason for the code being archived\n example: user_archival\n folder:\n type: object\n description: folder containing the code\n properties:\n folder_id:\n type: string\n description: numeric identifier of the folder\n example: 1234\n folder_name:\n type: string\n description: name of the folder\n example: child_folder\n folder_path:\n type: string\n description: hierarchical path to the folder, including the folder itself and its ancestors\n example: parent_folder/child_folder\n studio_config_id:\n type: string\n description: uuid of a studio configuration governing the appearance of the code\n format: uuid\n created_at:\n type: string\n description: timestamp of when the code was created\n example: \"2023-01-01T12:00:00.000000Z\"\n redirect_url:\n $ref: '#/components/schemas/ScanDestination'\n tags:\n type: array\n description: free form metadata tags that can be used for organizing, searching, and filtering codes\n items:\n type: string\n example: api\n smart_rules:\n $ref: '#/components/schemas/SmartRule'\n interstitials:\n type: array\n description: interstitial objects to apply to the code\n items:\n $ref: '#/components/schemas/Interstitial'\n ScanDestination:\n type: object\n description: A ScanDestination object defines the type of post-scan experience and the metadata associated with it.\n required:\n - destination_type\n - redirect_value\n properties:\n destination_type:\n $ref: '#/components/schemas/DestinationType'\n redirect_value:\n oneOf:\n - $ref: '#/components/schemas/SmsRedirect'\n - $ref: '#/components/schemas/PhoneRedirect'\n - $ref: '#/components/schemas/EmailRedirect'\n - $ref: '#/components/schemas/VenmoRedirect'\n - $ref: '#/components/schemas/WifiRedirect'\n - $ref: '#/components/schemas/UrlRedirect'\n DestinationType:\n type: string\n description: The type of experience a scanner is brought to upon scanning the code.\n enum:\n - SMS\n - PHONE\n - EMAIL\n - VENMO\n - WIFI\n - URL\n SmsRedirect:\n type: object\n required:\n - recipient\n description: The scanner will view a new text message to the entered phone number and will then have the ability to send. As an option, you are able to pre-fill the message.\n properties:\n recipient:\n type: string\n example: 555-555-5555\n message:\n type: string\n example: hello world\n PhoneRedirect:\n type: object\n required:\n - recipient\n description: The scanner will view a phone number which they will be able to call.\n properties:\n recipient:\n type: string\n example: 555-555-5555\n EmailRedirect:\n type: object\n required:\n - recipient\n description: The scanner will view a new message to the entered email address and will then have the ability to send. As an option, you are able to pre-fill the subject line and/or message in the body of the email.\n properties:\n recipient:\n type: string\n example: help-api@flowcode.com\n subject:\n type: string\n example: Reading your docs\n message:\n type: string\n example: Thanks for making some sweet documentation\n VenmoRedirect:\n type: object\n required:\n - recipient\n description: A scanner will be directed to a payment to the entered venmo username in their venmo app and will then have the ability to submit payment. As an option, you are able to pre-fill the message and/or the value of the payment.\n properties:\n recipient:\n type: string\n example: venmo-username\n amount:\n type: number\n example: 1.99\n message:\n type: string\n example: For my cool Flowcode\n WifiRedirect:\n type: object\n required:\n - network_name\n - hidden\n description: Scanners will be able to connect to wifi. This scan destination only works with static codes\n properties:\n network_name:\n type: string\n example: MySSID-5G\n hidden:\n type: boolean\n example: true\n security_type:\n type: string\n enum:\n - WPA\n - WEP\n - nopass\n password:\n type: string\n example: p@ssw0rd!\n UrlRedirect:\n type: object\n required:\n - url\n description: The address of a web page or website. The scanner will be directed to the url.\n properties:\n url:\n type: string\n example: https://mywebsite.com\n CodeTemplate:\n type: object\n description: A pre-defined set of customization options that govern the appearance of a code.\n properties:\n template_id:\n type: string\n description: uuid of the code template\n format: uuid\n name:\n type: string\n description: display name of code template\n example: My code template\n description:\n type: string\n description: description of the code template\n example: my super cool code template\n configuration:\n type: object\n description: JSON blob containing the customization options of the code template\n example: \"{\\\"key1\\\": \\\"value1\\\", \\\"key2\\\": \\\"value2\\\"}\"\n created_at:\n type: string\n description: timestamp of when the code template was created\n example: \"2023-01-01T12:00:00.000000Z\"\n modified_at:\n type: string\n description: timestamp of when the code template was last modified\n example: \"2023-01-01T12:00:00.000000Z\"\n ImageType:\n type: object\n required:\n - name\n - width_inches\n - colorspace\n - dpi\n - image_type\n properties:\n name:\n type: string\n description: Name to give image type\n example: My ImageType\n width_inches:\n type: integer\n format: int32\n description: Width in inches\n example: 2\n colorspace:\n type: string\n description: colorspace for tiff\n enum: [rgb, cmyk]\n dpi:\n type: integer\n format: int32\n description: DPI resolution\n example: 200\n studio_config_id:\n type: string\n format: uuid\n description: Optional studio configuration id\n studio_config:\n type: string\n format: JSON\n description: JSON blob of the studio configuration attributes\n example: \"{\\\"key1\\\": \\\"value1\\\", \\\"key2\\\": \\\"value2\\\"}\"\n image_type:\n type: string\n description: Type of image, default = png\n enum: [png, jpg, tiff, pdf, svg]\n Campaign:\n type: object\n required:\n - client_id\n - name\n - display_name\n - reserved_urls_unique\n properties:\n client_id:\n type: string\n format: uuid\n description: Client id string the flowcode team has given to you to make api requests\n name:\n type: string\n description: Unique name for campaign\n example: My Campaign\n display_name:\n type: string\n description: Display name for campaign\n example: My Campaign\n reserved_urls_unique:\n type: boolean\n description: True if each URL in the campaign in unique, false if there will be one URL with many flowcodes pointing to it\n image_types:\n type: array\n items:\n $ref: '#/components/schemas/ImageType'\n Interstitial:\n type: object\n description: An interstitial experience scanners are brought to before their final scan destination.\n required:\n - type\n properties:\n type:\n type: string\n description: Type of interstitial. Currently supports geo (advanced geolocation capture)\n example: geo\n Rule:\n type: object\n description: A logical set of conditions that, when met, result in a code scanning to the specified destination rather than its default destination.\n required:\n - destination\n properties:\n destination:\n $ref: '#/components/schemas/ScanDestination'\n days:\n type: array\n description: Optional array of numbers for days rule should apply to (0 = Sunday, 6 = Saturday)\n example: [0,1,2]\n items:\n type: integer\n enum: [0,1,2,3,4,5,6]\n start_time:\n type: string\n description: Optional HH:MM in 24 hour clock for start time rule should apply to\n pattern: ^(0[0-9]|1[0-9]|2[0-3]):[0-5][0-9]$\n example: \"14:45\"\n end_time:\n type: string\n description: Optional HH:MM in 24 hour clock for end time rule should apply to\n pattern: ^(0[0-9]|1[0-9]|2[0-3]):[0-5][0-9]$\n example: \"14:45\"\n device_type:\n type: string\n description: Type of scanning device the rule should apply to\n enum: [ANDROID, DESKTOP, IOS]\n region:\n type: string\n description: Geographic region of the scanner\n enum: [South, Midwest, West, Northeast]\n state:\n type: string\n example: NY\n description: State of the scanner\n county:\n type: string\n example: New York County\n description: County of the scanner\n zip:\n type: string\n example: \"10013\"\n description: Zip code of the scanner\n distance:\n type: integer\n description: Distance from a specified location\n minimum: 0\n example: 10\n distance_unit:\n type: string\n description: Unit of distance from specified location\n enum: [mi, km, m]\n from_lat:\n type: number\n description: Latitude of specified location\n format: float\n minimum: -90.0\n maximum: 90.0\n example: 40.75\n from_lng:\n type: number\n description: Longitude of specified location\n format: float\n minimum: -180.0\n maximum: 180.0\n example: -73.98\n SmartRule:\n type: object\n description: Smart Rules are a feature that enable scanners to be conditionally redirected based on their device type, time of day, day of week or location.\n required:\n - rules\n - time_zone\n properties:\n rules:\n type: array\n items:\n $ref: '#/components/schemas/Rule'\n time_zone:\n type: string\n description: Time zone for rules. SCANNER=use scanner's timezone\n enum: [SCANNER, Etc/GMT+12, Etc/GMT+11, Etc/GMT+10, Etc/GMT+9, America/Los_Angeles, America/Denver, America/Chicago, America/New_York, Etc/GMT+4, Etc/GMT+3, Etc/GMT+2, Etc/GMT+1, Europe/London, Europe/Berlin, Etc/GMT-2, Etc/GMT-3, Etc/GMT-4, Etc/GMT-5, Asia/Colombo, Asia/Kathmandu, Etc/GMT-6, Indian/Cocos, Etc/GMT-7, Etc/GMT-8, Etc/GMT-9, Pacific/Marquesas, Etc/GMT-10, Etc/GMT-11, Etc/GMT-12, Etc/GMT-13]\n Url:\n type: object\n required:\n - id\n - url_type\n - url\n - num_links\n properties:\n id:\n type: string\n description: ID to return in response\n example: id1\n url_type:\n type: string\n description: Type of URL (e.g. URL)\n example: URL\n url:\n type: string\n format: url\n description: URL shorturl should redirect to. The URL should be properly url encoded\n example: https://example.com\n nickname:\n type: string\n description: Optional name for code displayed in platform\n example: My Cool Flowcode\n num_links:\n type: integer\n format: int32\n description: Number of flowcodes to generate for URL for case where many flowcodes point to same URL (when campaign reserved_urls_unique = false)\n example: 100\n smart_rules:\n type: object\n description: Smart Rules are a feature that enable scanners to be conditionally redirected based on their device type, time of day, day of week or location.\n required:\n - rules\n - time_zone\n properties:\n rules:\n type: array\n items:\n type: object\n description: A logical set of conditions that, when met, result in a code scanning to the specified destination rather than its default destination.\n required:\n - url\n properties:\n url:\n type: string\n description: Desired destination URL\n example: https://google.com\n days:\n type: array\n description: Optional array of numbers for days rule should apply to (0 = Sunday, 6 = Saturday)\n example: [0,1,2]\n items:\n type: integer\n enum: [0,1,2,3,4,5,6]\n start_time:\n type: string\n description: Optional HH:MM in 24 hour clock for start time rule should apply to\n pattern: ^(0[0-9]|1[0-9]|2[0-3]):[0-5][0-9]$\n example: \"14:45\"\n end_time:\n type: string\n description: Optional HH:MM in 24 hour clock for end time rule should apply to\n pattern: ^(0[0-9]|1[0-9]|2[0-3]):[0-5][0-9]$\n example: \"14:45\"\n device_type:\n type: string\n description: Type of scanning device the rule should apply to\n enum: [ANDROID, DESKTOP, IOS]\n region:\n type: string\n description: Geographic region of the scanner\n enum: [South, Midwest, West, Northeast]\n state:\n type: string\n example: NY\n description: State of the scanner\n county:\n type: string\n example: New York County\n description: County of the scanner\n zip:\n type: string\n example: \"10013\"\n description: Zip code of the scanner\n distance:\n type: integer\n description: Distance from a specified location\n minimum: 0\n example: 10\n distance_unit:\n type: string\n description: Unit of distance from specified location\n enum: [mi, km, m]\n from_lat:\n type: number\n description: Latitude of specified location\n format: float\n minimum: -90.0\n maximum: 90.0\n example: 40.75\n from_lng:\n type: number\n description: Longitude of specified location\n format: float\n minimum: -180.0\n maximum: 180.0\n example: -73.98\n time_zone:\n type: string\n description: Time zone for rules. SCANNER=use scanner's timezone\n enum: [SCANNER, Etc/GMT+12, Etc/GMT+11, Etc/GMT+10, Etc/GMT+9, America/Los_Angeles, America/Denver, America/Chicago, America/New_York, Etc/GMT+4, Etc/GMT+3, Etc/GMT+2, Etc/GMT+1, Europe/London, Europe/Berlin, Etc/GMT-2, Etc/GMT-3, Etc/GMT-4, Etc/GMT-5, Asia/Colombo, Asia/Kathmandu, Etc/GMT-6, Indian/Cocos, Etc/GMT-7, Etc/GMT-8, Etc/GMT-9, Pacific/Marquesas, Etc/GMT-10, Etc/GMT-11, Etc/GMT-12, Etc/GMT-13]\n ScanEvent:\n type: object\n properties:\n event_id:\n type: string\n description: The unique identifier for the event\n format: uuid\n event_time:\n type: string\n description: The time of the event (EST/EDT)\n example: \"2023-01-01T12:00:00.000000Z\"\n event_type_id:\n type: integer\n description: The unique identifier for the specific event type. The event name can be retrieved from the event types endpoint\n example: 1\n asset_id:\n type: string\n description: The unique identifier for the batch containing the flowcode. All codes in a batch have the same destination\n example: gKcvT\n flowcode_id:\n type: string\n description: The unique identifier for the flowcode within the batch\n example: gKcvTr0s\n nickname:\n type: string\n description: The name assigned to the batch\n example: code_1\n rdservice_cookie:\n type: string\n description: The cookie to identify repeat scanners. May be empty/null\n example: 58CC84CC32204746BD4433FCD06420DD\n operating_system_id:\n type: integer\n description: The unique identifier for the operating system used to initiate the event. The operating system name can be retrieved from the operating systems endpoint. May be empty/null\n example: 3\n postal_code:\n type: string\n description: The postal code from which the event was initiated. May be empty/null\n example: \"02145\"\n state:\n type: string\n description: The state (US)/province/territory/region from which the event was initiated. May be empty/null\n example: MA\n country:\n type: string\n description: The 2 digit country code from which the event was initiated. May be empty/null\n example: US\n city:\n type: string\n description: The city from which the event was initiated. May be empty/null\n example: Somerville\n latitude:\n type: number\n description: Latitude of location where the event was initiated\n format: float\n minimum: -90.0\n maximum: 90.0\n example: 40.75\n longitude:\n type: number\n description: Longitude of location where the event was initiated\n format: float\n minimum: -180.0\n maximum: 180.0\n example: -73.98\n geolocation_source:\n type: string\n description: Source used to obtain the geo data\n enum: [unknown, IP, device]\n example: IP\n redirect_url:\n type: string\n description: The redirect url assigned to the asset\n example: https://google.com\n PageEvent:\n type: object\n properties:\n event_id:\n type: string\n description: The unique identifier for the event\n format: uuid\n event_time:\n type: string\n description: The time of the event (EST/EDT)\n example: \"2023-01-01T12:00:00.000000Z\"\n event_type_id:\n type: integer\n description: The unique identifier for the specific event type. The event name can be retrieved from the event types endpoint\n example: 2\n page_id:\n type: string\n description: The unique identifier for the page on which the event was triggered\n format: uuid\n page_title:\n type: string\n description: The title assigned to the page\n example: Page Title\n link_id:\n type: string\n description: The unique identifier for the link on which the event was triggered. May be empty / null if event is a page view\n format: uuid\n link_title:\n type: integer\n description: The title assigned to the link. May be empty / null if event is a page view\n example: My Socials Link\n rdservice_cookie:\n type: string\n description: The cookie to identify repeat viewers. May be empty/null\n example: 58CC84CC32204746BD4433FCD06420DD\n operating_system_id:\n type: integer\n description: The unique identifier for the operating system used to initiate the event. The operating system name can be retrieved from the operating systems endpoint. May be empty/null\n example: 3\n postal_code:\n type: string\n description: The postal code from which the event was initiated. May be empty/null\n example: \"02145\"\n state:\n type: string\n description: The state (US)/province/territory/region from which the event was initiated. May be empty/null\n example: MA\n country:\n type: string\n description: The 2 digit country code from which the event was initiated. May be empty/null\n example: US\n city:\n type: string\n description: The city from which the event was initiated. May be empty/null\n example: Somerville\n latitude:\n type: number\n description: Latitude of location where the event was initiated\n format: float\n minimum: -90.0\n maximum: 90.0\n example: 40.75\n longitude:\n type: number\n description: Longitude of location where the event was initiated\n format: float\n minimum: -180.0\n maximum: 180.0\n example: -73.98\n geolocation_source:\n type: string\n description: Source used to obtain the geo data\n enum: [unknown, IP, device]\n example: IP\n ScanEventSummary:\n type: object\n properties:\n start_time:\n type: string\n description: The beginning of the specified interval (EST/EDT, inclusive)\n example: \"2023-01-01T12:00:00.000000Z\"\n end_time:\n type: string\n description: The end of the specified interval (EST/EDT, exclusive)\n example: \"2023-02-01T12:00:00.000000Z\"\n scans:\n type: integer\n description: The number of scans in the specified interval\n example: 1000\n PageEventSummary:\n type: object\n properties:\n start_time:\n type: string\n description: The beginning of the specified interval (EST/EDT, inclusive)\n example: \"2023-01-01T12:00:00.000000Z\"\n end_time:\n type: string\n description: The end of the specified interval (EST/EDT, exclusive)\n example: \"2023-02-01T12:00:00.000000Z\"\n page_views:\n type: integer\n description: The number of page views in the specified interval\n example: 1000\n link_clicks:\n type: integer\n description: The number of link clicks in the specified interval\n example: 500\n clickthrough_rate:\n type: number\n description: The ratio of link_clicks to page_views\n example: 0.5\n EventType:\n type: object\n properties:\n id:\n type: integer\n description: The unique identifier for the specific event type\n example: 1\n name:\n type: string\n description: The name of the event type\n example: scan\n OperatingSystem:\n type: object\n properties:\n id:\n type: integer\n description: The unique identifier for the operating system used to initiate the event\n example: 3\n name: \n type: string\n description: The name of the operating system used to initiate the event\n example: iOS\n Product:\n type: object\n properties:\n id:\n type: integer\n description: The unique identifier for the product\n example: 1\n name: \n type: string\n description: The name of the product\n example: flowpage\n Contact:\n type: object\n properties:\n capturedAt:\n type: string\n description: Timestamp of when the contact info was collected\n example: \"2023-01-01T12:00:00.000000Z\"\n id:\n type: string\n description: Unique identifier for the contact info\n format: uuid\n createdAt:\n type: string\n description: Timestamp of when the contact was created\n example: \"2023-01-01T12:00:00.000000Z\"\n sourceId:\n type: string\n description: Unique identifier for the source of the contact info collection\n example: flowpages://link/d6a84b9b-18b3-427c-9556-b87ca2eadf0b\n email:\n type: string\n description: Email of the contact\n example: me@flowcode.com\n displayName:\n type: string\n description: Display name of the contact\n example: Flow Code\n phone:\n type: string\n description: Phone number of the contact\n example: 555-555-5555\n displayData:\n type: object\n properties:\n order:\n type: integer\n title:\n type: string\n example: My contact collection page\n description:\n type: string\n example: capture for crm leads\n age:\n type: string\n description: Age of the contact\n example: 25\n gender:\n type: string\n description: Gender of the contact. May be empty/null\n example: null\n custom:\n type: object\n description: Free form field for custom info\n example: null\n custom2:\n type: object\n description: Free form field for custom info\n example: null\n address:\n type: string\n description: Address of the contact\n example: null\nsecurity:\n - ApiKeyAuth: [] # global keyauth"

{}