### Get an Asset Source: https://developers.fireberry.com/reference/get-an-asset Retrieves details for a specific asset using its GUID. This endpoint allows you to fetch comprehensive data about an account product. ```APIDOC ## GET /api/record/accountproduct/{id} ### Description Retrieves details for a specific asset using its GUID. ### Method GET ### Endpoint /api/record/accountproduct/{id} ### Parameters #### Path Parameters - **id** (string) - Required - Use an asset's GUID. ### Request Example ```json { "example": "GET /api/record/accountproduct/YOUR_ASSET_ID" } ``` ### Response #### Success Response (200) - **success** (boolean) - Indicates if the request was successful. - **data** (object) - Contains the asset data. - **Record** (object) - Data about the specific account product including all its fields and values. - **message** (string) - Any message associated with the response. #### Response Example ```json { "success": true, "data": { "Record": { "field1": "value1", "field2": "value2" } }, "message": "" } ``` #### Error Response (400) - **Message** (string) - Describes the error, e.g., "Invalid type for parameter ID". #### Error Response Example (400) ```json { "Message": "Invalid type for parameter ID" } ``` ``` -------------------------------- ### OpenAPI Definition for Get Product Source: https://developers.fireberry.com/reference/get-a-product This OpenAPI 3.1.0 definition specifies the 'get-a-product' operation for the Fireberry API. It includes details on the request path, parameters, security schemes, and possible response codes (200, 400, 401) with example payloads. The API requires an 'tokenid' in the header for authentication. ```json { "openapi": "3.1.0", "info": { "title": "fireberry-api", "version": "1.0" }, "servers": [ { "url": "https://api.fireberry.com" } ], "components": { "securitySchemes": { "sec0": { "type": "apiKey", "in": "header", "name": "tokenid" } } }, "security": [ { "sec0": [] } ], "paths": { "/api/record/product/{id}": { "get": { "summary": "Get a Product", "description": "", "operationId": "get-a-product", "parameters": [ { "name": "id", "in": "path", "description": "Use a product's GUID.", "schema": { "type": "string" }, "required": true } ], "responses": { "200": { "description": "200", "content": { "application/json": { "examples": { "Result": { "value": "{\n \"success\": true,\n \"data\": {\n \"Record\": {\n Data about the specific Product including all its fields and values\n }\n },\n \"message\": \"\"\n}\n" } } } } }, "400": { "description": "400", "content": { "application/json": { "examples": { "Result": { "value": "{\n \"Message\": \"Invalid type for parameter ID\"\n}" } }, "schema": { "type": "object", "properties": { "Message": { "type": "string", "example": "Invalid type for parameter ID" } } } } } }, "401": { "description": "401", "content": { "application/json": { "examples": { "Result": { "value": "" } } } } } }, "deprecated": false } } }, "x-readme": { "headers": [], "explorer-enabled": true, "proxy-enabled": true }, "x-readme-fauxas": true } ``` -------------------------------- ### Get a Task Source: https://developers.fireberry.com/reference/get-a-task Retrieves details for a specific task using its unique identifier (GUID). ```APIDOC ## GET /api/record/task/{id} ### Description Retrieves details for a specific task using its unique identifier (GUID). ### Method GET ### Endpoint /api/record/task/{id} ### Parameters #### Path Parameters - **id** (string) - Required - Use a task's GUID. ### Request Example (No request body for GET requests) ### Response #### Success Response (200) - **success** (boolean) - Indicates if the request was successful. - **data** (object) - Contains the task data. - **Record** (object) - Data about the specific Task including all its fields and values. - **message** (string) - Any messages associated with the response. #### Response Example ```json { "success": true, "data": { "Record": { "Record about the specific Task including all its fields and values" } }, "message": "" } ``` #### Error Response (400) - **Message** (string) - Error message indicating an invalid parameter type. #### Error Response Example (400) ```json { "Message": "Invalid type for parameter ID" } ``` ``` -------------------------------- ### Get a Product Source: https://developers.fireberry.com/reference/get-a-product Retrieves details for a specific product using its unique identifier. ```APIDOC ## GET /api/record/product/{id} ### Description Retrieves details for a specific product using its unique identifier. ### Method GET ### Endpoint https://api.fireberry.com/api/record/product/{id} ### Parameters #### Path Parameters - **id** (string) - Required - Use a product's GUID. ### Request Example (No request body for GET requests) ### Response #### Success Response (200) - **success** (boolean) - Indicates if the request was successful. - **data** (object) - Contains the product data. - **Record** (object) - Data about the specific Product including all its fields and values. #### Response Example ```json { "success": true, "data": { "Record": { Data about the specific Product including all its fields and values } }, "message": "" } ``` #### Error Response (400) - **Message** (string) - Description of the error. #### Error Response Example ```json { "Message": "Invalid type for parameter ID" } ``` ``` -------------------------------- ### API Response Example for Record Creation Source: https://developers.fireberry.com/reference/update-an-invoice This snippet demonstrates a successful API response (200 OK) when creating a record. It includes a success flag, the created record's data, and a message field. It also shows an example of a 400 Bad Request response indicating a validation error with a specific field. ```JSON { "success": true, "data": { "Record": {Data about the created No Invoice including all its fields and values} }, "message": "" } ``` ```JSON { "Message": "'FIELD NAME' must be a valid DateTime" } ``` -------------------------------- ### Get an Activity Log Source: https://developers.fireberry.com/reference/get-an-activity-log Retrieves a specific activity log entry using its unique identifier (GUID). ```APIDOC ## GET /api/record/activitylog/{id} ### Description Retrieves a specific activity log entry using its unique identifier (GUID). ### Method GET ### Endpoint /api/record/activitylog/{id} ### Parameters #### Path Parameters - **id** (string) - Required - Use an activity log's GUID. ### Request Example ```json { "example": "No request body needed for GET request." } ``` ### Response #### Success Response (200) - **success** (boolean) - Indicates if the request was successful. - **data** (object) - Contains the activity log data. - **Record** (object) - Data about the specific activity including all its fields and values. - **message** (string) - Any relevant message from the server. #### Response Example ```json { "success": true, "data": { "Record": { "Data about the specific activity including all its fields and values" } }, "message": "" } ``` #### Error Response (400) - **Message** (string) - Description of the error, e.g., "Invalid type for parameter ID". #### Error Response Example (400) ```json { "Message": "Invalid type for parameter ID" } ``` ``` -------------------------------- ### GET /api/record/product Source: https://developers.fireberry.com/reference/get-all-product Retrieves a list of all products available in the system. Supports pagination and allows filtering by page size and page number. ```APIDOC ## GET /api/record/product ### Description Retrieves a list of all products. This endpoint supports pagination parameters to control the number of results per page and the page number. ### Method GET ### Endpoint /api/record/product ### Parameters #### Query Parameters - **pagesize** (string) - Optional - The maximum number of records displayed per page, cannot exceed 50. Defaults to "50". - **pagenumber** (string) - Optional - The number of the page displayed, cannot exceed 10. Defaults to "1". ### Request Example ```json { "pagesize": "50", "pagenumber": "1" } ``` ### Response #### Success Response (200) - **success** (boolean) - Indicates if the request was successful. - **data** (object) - Contains the product data and pagination details. - **PrimaryKey** (string) - The primary key field for the records. - **PrimaryField** (string) - The primary display field for the records. - **Total_Records** (integer) - The total number of records available. - **Page_Size** (integer) - The number of records per page. - **Page_Number** (integer) - The current page number. - **Records** (array) - An array containing data about all the Products including all their fields and values. - **message** (string) - A message associated with the response. #### Response Example ```json { "success": true, "data": { "PrimaryKey": "activityid", "PrimaryField": "subject", "Total_Records": 0, "Page_Size": 50, "Page_Number": 1, "Records": [Data about all of the Products including all their fields and values] }, "message": "" } ``` #### Error Response (400) - **Message** (string) - Describes the error, e.g., "Invalid Object Name". #### Error Response Example (400) ```json { "Message": "Invalid Object Name" } ``` #### Error Response (401) - No specific schema provided for 401 error. ``` -------------------------------- ### Credit Invoice Response Example (JSON) Source: https://developers.fireberry.com/reference/create-a-credit-invoice This example demonstrates the structure of a successful response when creating a credit invoice. It includes success status, detailed record data, and a message field. The 'Record' object contains all fields and their values for the created credit invoice. ```json { "success": true, "data": { "Record": {Data about the created Credit Invoice including all its fields and values} }, "message": "" } ``` -------------------------------- ### OpenAPI Definition for Get All Assets Source: https://developers.fireberry.com/reference/get-all-assets This OpenAPI 3.1.0 definition outlines the 'Get all Assets' endpoint for the fireberry-api. It specifies the HTTP method (GET), request parameters ('pagesize', 'pagenumber'), security scheme (apiKey), and potential responses (200, 400, 401). ```json { "openapi": "3.1.0", "info": { "title": "fireberry-api", "version": "1.0" }, "servers": [ { "url": "https://api.fireberry.com" } ], "components": { "securitySchemes": { "sec0": { "type": "apiKey", "in": "header", "name": "tokenid" } } }, "security": [ { "sec0": [] } ], "paths": { "/api/record/accountproduct": { "get": { "summary": "Get all Assets", "description": "", "operationId": "get-all-assets", "parameters": [ { "name": "pagesize", "in": "query", "description": "The maximum number of records displayed per page, cannot exceed 50", "schema": { "type": "string", "default": "50" } }, { "name": "pagenumber", "in": "query", "description": "The number of the page displayed, cannot exceed 10", "schema": { "type": "string", "default": "1" } } ], "responses": { "200": { "description": "200", "content": { "application/json": { "examples": { "Result": { "value": "{\n \"success\": true,\n \"data\": {\n \"PrimaryKey\": \"accountproductid\",\n \"PrimaryField\": \"productid\",\n \"Total_Records\": 0,\n \"Page_Size\": 50,\n \"Page_Number\": 1,\n \"Records\": [Data about all of the account products including all their fields and values]\n },\n \"message\": \"\"\n}" } } } } }, "400": { "description": "400", "content": { "application/json": { "examples": { "Result": { "value": "{\n \"Message\": \"Invalid Object Name\"\n}" } }, "schema": { "type": "object", "properties": { "Message": { "type": "string", "example": "Invalid Object Name" } } } } } }, "401": { "description": "401", "content": { "application/json": { "examples": { "Result": { "value": "" } } } } } }, "deprecated": false } } }, "x-readme": { "headers": [], "explorer-enabled": true, "proxy-enabled": true }, "x-readme-fauxas": true } ``` -------------------------------- ### GET /api/v2/record/81/{id}/items Source: https://developers.fireberry.com/reference/get-invoice-items Fetches all items for a specific invoice using its unique identifier (GUID). The response includes details for each item such as amount, price, and description. ```APIDOC ## GET /api/v2/record/81/{id}/items ### Description Retrieves all items associated with a specific invoice, including detailed information for each item such as amount, price, and description. ### Method GET ### Endpoint /api/v2/record/81/{id}/items ### Parameters #### Path Parameters - **id** (string) - Required - The unique identifier (GUID) of the invoice. ### Request Example ```json { "example": "Request body not applicable for GET request." } ``` ### Response #### Success Response (200) - **Result** (object) - Contains an object with invoice item details. (Schema details not provided in the source, represented as empty object {}) #### Response Example ```json { "example": "{}" } ``` #### Error Response (400) - **Result** (object) - Indicates a bad request. (Schema details not provided in the source, represented as empty object {}) #### Error Response Example ```json { "example": "{}" } ``` ``` -------------------------------- ### GET /api/record/accountproduct Source: https://developers.fireberry.com/reference/get-all-assets Retrieves a list of all account products. Supports pagination with `pagesize` and `pagenumber` query parameters. ```APIDOC ## GET /api/record/accountproduct ### Description Retrieves all assets (account products) associated with the account. This endpoint supports pagination to manage large datasets. ### Method GET ### Endpoint /api/record/accountproduct ### Parameters #### Query Parameters - **pagesize** (string) - Optional - The maximum number of records displayed per page, cannot exceed 50. Defaults to "50". - **pagenumber** (string) - Optional - The number of the page displayed, cannot exceed 10. Defaults to "1". ### Request Example ```json { "example": "" } ``` ### Response #### Success Response (200) - **success** (boolean) - Indicates if the request was successful. - **data** (object) - Contains the asset data. - **PrimaryKey** (string) - The primary key field name for account products. - **PrimaryField** (string) - The primary field name for account products. - **Total_Records** (integer) - The total number of records available. - **Page_Size** (integer) - The number of records per page. - **Page_Number** (integer) - The current page number. - **Records** (array) - An array containing data about all of the account products including all their fields and values. - **message** (string) - A message associated with the response. #### Response Example ```json { "success": true, "data": { "PrimaryKey": "accountproductid", "PrimaryField": "productid", "Total_Records": 0, "Page_Size": 50, "Page_Number": 1, "Records": [Data about all of the account products including all their fields and values] }, "message": "" } ``` #### Error Response (400) - **Message** (string) - Describes the error, e.g., "Invalid Object Name". #### Error Response Example (400) ```json { "Message": "Invalid Object Name" } ``` #### Error Response (401) - No specific schema provided for 401 error response. #### Error Response Example (401) ```json { "example": "" } ``` ``` -------------------------------- ### OpenAPI Definition for Get All Products Source: https://developers.fireberry.com/reference/get-all-product This JSON object defines the OpenAPI 3.1.0 specification for the Fireberry API's product retrieval endpoint. It includes details on the server URL, security schemes, and the '/api/record/product' GET path with its parameters and responses. ```json { "openapi": "3.1.0", "info": { "title": "fireberry-api", "version": "1.0" }, "servers": [ { "url": "https://api.fireberry.com" } ], "components": { "securitySchemes": { "sec0": { "type": "apiKey", "in": "header", "name": "tokenid" } } }, "security": [ { "sec0": [] } ], "paths": { "/api/record/product": { "get": { "summary": "Get all Products", "description": "", "operationId": "get-all-product", "parameters": [ { "name": "pagesize", "in": "query", "description": "The maximum number of records displayed per page, cannot exceed 50.", "schema": { "type": "string", "default": "50" } }, { "name": "pagenumber", "in": "query", "description": "The number of the page displayed, cannot exceed 10.", "schema": { "type": "string", "default": "1" } } ], "responses": { "200": { "description": "200", "content": { "application/json": { "examples": { "Result": { "value": "{\n \"success\": true,\n \"data\": {\n \"PrimaryKey\": \"activityid\",\n \"PrimaryField\": \"subject\",\n \"Total_Records\": 0,\n \"Page_Size\": 50,\n \"Page_Number\": 1,\n \"Records\": [Data about all of the Products including all their fields and values]\n },\n \"message\": \"\"\n}" } } } } }, "400": { "description": "400", "content": { "application/json": { "examples": { "Result": { "value": "{\n \"Message\": \"Invalid Object Name\"\n}" } }, "schema": { "type": "object", "properties": { "Message": { "type": "string", "example": "Invalid Object Name" } } } } } }, "401": { "description": "401", "content": { "application/json": { "examples": { "Result": { "value": "" } } } } } }, "deprecated": false } } }, "x-readme": { "headers": [], "explorer-enabled": true, "proxy-enabled": true }, "x-readme-fauxas": true } ``` -------------------------------- ### OpenAPI Definition for Get Credit Invoice Source: https://developers.fireberry.com/reference/get-a-credit-invoice This OpenAPI 3.1.0 definition outlines the structure and parameters for the 'Get a Credit Invoice' endpoint. It specifies the request method (GET), path parameters, authentication, and possible responses, including success (200) and error (400, 401) scenarios. The definition includes example request and response payloads. ```json { "openapi": "3.1.0", "info": { "title": "fireberry-api", "version": "1.0" }, "servers": [ { "url": "https://api.fireberry.com" } ], "components": { "securitySchemes": { "sec0": { "type": "apiKey", "in": "header", "name": "tokenid" } } }, "security": [ { "sec0": [] } ], "paths": { "/api/record/invoicecredit/{id}": { "get": { "summary": "Get a Credit Invoice", "description": "", "operationId": "get-a-credit-invoice", "parameters": [ { "name": "id", "in": "path", "description": "Use a Credit Invoice's GUID.", "schema": { "type": "string" }, "required": true } ], "responses": { "200": { "description": "200", "content": { "application/json": { "examples": { "Result": { "value": "{\n \"success\": true,\n \"data\": {\n \"Record\": {\n Data about the specific Credit Invoice including all its fields and values\n }\n },\n \"message\": \"\"\n}\n" } } } } }, "400": { "description": "400", "content": { "application/json": { "examples": { "Result": { "value": "{\n \"Message\": \"Invalid type for parameter ID\"\n}" } }, "schema": { "type": "object", "properties": { "Message": { "type": "string", "example": "Invalid type for parameter ID" } } } } } }, "401": { "description": "401", "content": { "application/json": { "examples": { "Result": { "value": "" } } } } } }, "deprecated": false } } }, "x-readme": { "headers": [], "explorer-enabled": true, "proxy-enabled": true }, "x-readme-fauxas": true } ``` -------------------------------- ### Get All Tasks - OpenAPI Definition Source: https://developers.fireberry.com/reference/get-all-tasks This OpenAPI 3.1.0 definition describes the GET endpoint for retrieving all tasks from the Fireberry API. It specifies query parameters for pagination (pagesize, pagenumber), authentication using an API key, and provides example responses for success and error scenarios. The 'pagesize' parameter is limited to 50, and 'pagenumber' to 10. ```json { "openapi": "3.1.0", "info": { "title": "fireberry-api", "version": "1.0" }, "servers": [ { "url": "https://api.fireberry.com" } ], "components": { "securitySchemes": { "sec0": { "type": "apiKey", "in": "header", "name": "tokenid" } } }, "security": [ { "sec0": [] } ], "paths": { "/api/record/task": { "get": { "summary": "Get all Tasks", "description": "", "operationId": "get-all-tasks", "parameters": [ { "name": "pagesize", "in": "query", "description": "The maximum number of records displayed per page, cannot exceed 50.", "schema": { "type": "string", "default": "50" } }, { "name": "pagenumber", "in": "query", "description": "The number of the page displayed, cannot exceed 10.", "schema": { "type": "string", "default": "1" } } ], "responses": { "200": { "description": "200", "content": { "application/json": { "examples": { "Result": { "value": "{\n \"success\": true,\n \"data\": {\n \"PrimaryKey\": \"activityid\",\n \"PrimaryField\": \"subject\",\n \"Total_Records\": 0,\n \"Page_Size\": 50,\n \"Page_Number\": 1,\n \"Records\": [Data about all of the Tasks including all their fields and values]\n },\n \"message\": \"\"\n}" } } } } }, "400": { "description": "400", "content": { "application/json": { "examples": { "Result": { "value": "{\n \"Message\": \"Invalid Object Name\"\n}" } }, "schema": { "type": "object", "properties": { "Message": { "type": "string", "example": "Invalid Object Name" } } } } } }, "401": { "description": "401", "content": { "application/json": { "examples": { "Result": { "value": "" } } } } } }, "deprecated": false } } }, "x-readme": { "headers": [], "explorer-enabled": true, "proxy-enabled": true }, "x-readme-fauxas": true } ``` -------------------------------- ### Get All Notes OpenAPI Definition Source: https://developers.fireberry.com/reference/get-all-notes This OpenAPI 3.1.0 definition describes the GET endpoint for retrieving all notes from the Fireberry API. It specifies parameters for pagination (pagesize, pagenumber) and details the expected success and error responses, including their schemas and examples. ```json { "openapi": "3.1.0", "info": { "title": "fireberry-api", "version": "1.0" }, "servers": [ { "url": "https://api.fireberry.com" } ], "components": { "securitySchemes": { "sec0": { "type": "apiKey", "in": "header", "name": "tokenid" } } }, "security": [ { "sec0": [] } ], "paths": { "/api/record/note": { "get": { "summary": "Get all Notes", "description": "", "operationId": "get-all-notes", "parameters": [ { "name": "pagesize", "in": "query", "description": "The maximum number of records displayed per page, cannot exceed 50.", "schema": { "type": "string", "default": "50" } }, { "name": "pagenumber", "in": "query", "description": "The number of the page displayed, cannot exceed 10.", "schema": { "type": "string", "default": "1" } } ], "responses": { "200": { "description": "200", "content": { "application/json": { "examples": { "Result": { "value": "{\n \"success\": true,\n \"data\": {\n \"PrimaryKey\": \"activityid\",\n \"PrimaryField\": \"subject\",\n \"Total_Records\": 0,\n \"Page_Size\": 50,\n \"Page_Number\": 1,\n \"Records\": [Data about all of the Draft Invoices including all their fields and values]\n },\n \"message\": \"\"\n}" } } } } }, "400": { "description": "400", "content": { "application/json": { "examples": { "Result": { "value": "{\n \"Message\": \"Invalid Object Name\"\n}" } }, "schema": { "type": "object", "properties": { "Message": { "type": "string", "example": "Invalid Object Name" } } } } } }, "401": { "description": "401", "content": { "application/json": { "examples": { "Result": { "value": "" } } } } } }, "deprecated": false } } }, "x-readme": { "headers": [], "explorer-enabled": true, "proxy-enabled": true }, "x-readme-fauxas": true } ``` -------------------------------- ### OpenAPI Definition for Get All Accounts Source: https://developers.fireberry.com/reference/get-all-accounts This OpenAPI 3.1.0 definition describes the 'Get all Accounts' endpoint. It specifies the HTTP method (GET), available query parameters ('pagesize', 'pagenumber'), expected request headers (authentication token), and possible response structures for success (200) and error scenarios (400, 401). ```json { "openapi": "3.1.0", "info": { "title": "fireberry-api", "version": "1.0" }, "servers": [ { "url": "https://api.fireberry.com" } ], "components": { "securitySchemes": { "sec0": { "type": "apiKey", "in": "header", "name": "tokenid" } } }, "security": [ { "sec0": [] } ], "paths": { "/api/record/account": { "get": { "summary": "Get all Accounts", "description": "", "operationId": "get-all-accounts", "parameters": [ { "name": "pagesize", "in": "query", "description": "The maximum number of records displayed per page, cannot exceed 50.", "schema": { "type": "string", "default": "50" } }, { "name": "pagenumber", "in": "query", "description": "The number of the page displayed, cannot exceed 10.", "schema": { "type": "string", "default": "1" } } ], "responses": { "200": { "description": "200", "content": { "application/json": { "examples": { "Result": { "value": "{\n \"success\": true,\n \"data\": {\n \"PrimaryKey\": \"accountid\",\n \"PrimaryField\": \"accountname\",\n \"Total_Records\": 1,\n \"Page_Size\": 50,\n \"Page_Number\": 1,\n \"Records\": [Data about all of the accounts including all their fields and values]\n },\n \"message\": \"\"\n}" } } } } }, "400": { "description": "400", "content": { "application/json": { "examples": { "Result": { "value": "{\n \"Message\": \"Invalid Object Name\"\n}" } }, "schema": { "type": "object", "properties": { "Message": { "type": "string", "example": "Invalid Object Name" } } } } } }, "401": { "description": "401", "content": { "application/json": { "examples": { "Result": { "value": "" } } } } } }, "deprecated": false } } }, "x-readme": { "headers": [], "explorer-enabled": true, "proxy-enabled": true }, "x-readme-fauxas": true } ``` -------------------------------- ### GET /api/record/project Source: https://developers.fireberry.com/reference/get-all-projects Retrieves a list of all projects with pagination support. ```APIDOC ## GET /api/record/project ### Description Retrieves a list of all projects. Supports pagination through `pagesize` and `pagenumber` query parameters. ### Method GET ### Endpoint `/api/record/project` ### Parameters #### Query Parameters - **pagesize** (string) - Optional - The maximum number of records displayed per page, cannot exceed 50. Defaults to "50". - **pagenumber** (string) - Optional - The number of the page displayed, cannot exceed 10. Defaults to "1". ### Request Example ```json { "example": "No request body for GET request." } ``` ### Response #### Success Response (200) - **success** (boolean) - Indicates if the request was successful. - **data** (object) - Contains the project data and pagination information. - **PrimaryKey** (string) - The primary key field for projects. - **PrimaryField** (string) - The primary display field for projects. - **Total_Records** (integer) - The total number of projects available. - **Page_Size** (integer) - The number of records per page. - **Page_Number** (integer) - The current page number. - **Records** (array) - An array containing project data objects. - **message** (string) - A message indicating the status of the request. #### Response Example ```json { "success": true, "data": { "PrimaryKey": "activityid", "PrimaryField": "subject", "Total_Records": 0, "Page_Size": 50, "Page_Number": 1, "Records": [Data about all of the Projects including all their fields and values] }, "message": "" } ``` #### Error Response (400) - **Message** (string) - Description of the error, e.g., "Invalid Object Name". #### Error Response (401) - Description: Unauthorized. No specific example provided in the definition. ``` -------------------------------- ### Get an Account - OpenAPI Definition Source: https://developers.fireberry.com/reference/get-an-account This OpenAPI definition describes the 'Get an Account' endpoint. It specifies the HTTP method (GET), parameters (account ID), request/response formats (JSON), and possible status codes (200, 400, 401). ```json { "openapi": "3.1.0", "info": { "title": "fireberry-api", "version": "1.0" }, "servers": [ { "url": "https://api.fireberry.com" } ], "components": { "securitySchemes": { "sec0": { "type": "apiKey", "in": "header", "name": "tokenid" } } }, "security": [ { "sec0": [] } ], "paths": { "/api/record/account/{id}": { "get": { "summary": "Get an Account", "description": "", "operationId": "get-an-account", "parameters": [ { "name": "id", "in": "path", "description": "Use an account's GUID.", "schema": { "type": "string" }, "required": true } ], "responses": { "200": { "description": "200", "content": { "application/json": { "examples": { "Result": { "value": "{\n \"success\": true,\n \"data\": {\n \"Record\": {Data about the specific account including all fields and their values}\n },\n \"message\": \"\"\n}" } } } } }, "400": { "description": "400", "content": { "application/json": { "examples": { "Result": { "value": "{\n \"Message\": \"Invalid Object Name\"\n}" }, "Bad Request": { "value": "{\n \"Message\": \"Invalid type for parameter ID\"\n}" } }, "schema": { "oneOf": [ { "type": "object", "properties": { "Message": { "type": "string", "example": "Invalid Object Name" } } }, { "title": "Bad Request", "type": "object", "properties": { "Message": { "type": "string", "example": "Invalid type for parameter ID" } } } ] } } } }, "401": { "description": "401", "content": { "text/plain": { "examples": { "Result": { "value": "" } } } } } }, "deprecated": false } } }, "x-readme": { "headers": [], "explorer-enabled": true, "proxy-enabled": true }, "x-readme-fauxas": true } ``` -------------------------------- ### OpenAPI Definition for Get a Ticket Source: https://developers.fireberry.com/reference/get-a-ticket This OpenAPI 3.1.0 definition describes the 'Get a Ticket' endpoint. It specifies the HTTP method (GET), the URL path (/api/record/cases/{id}), and the required 'id' parameter. The definition includes example responses for successful retrieval (200) and error scenarios (400, 401), along with security scheme details using an API key in the header. ```json { "openapi": "3.1.0", "info": { "title": "fireberry-api", "version": "1.0" }, "servers": [ { "url": "https://api.fireberry.com" } ], "components": { "securitySchemes": { "sec0": { "type": "apiKey", "in": "header", "name": "tokenid" } } }, "security": [ { "sec0": [] } ], "paths": { "/api/record/cases/{id}": { "get": { "summary": "Get a Ticket", "description": "", "operationId": "get-a-ticket", "parameters": [ { "name": "id", "in": "path", "description": "Use a ticket's GUID.", "schema": { "type": "string" }, "required": true } ], "responses": { "200": { "description": "200", "content": { "application/json": { "examples": { "Result": { "value": "{\n \"success\": true,\n \"data\": {\n \"Record\": {\n Data about the specific case including all its fields and values\n }\n },\n \"message\": \"\"\n}\n" } } } } }, "400": { "description": "400", "content": { "application/json": { "examples": { "Result": { "value": "{\n \"Message\": \"Invalid type for parameter ID\"\n}" } }, "schema": { "type": "object", "properties": { "Message": { "type": "string", "example": "Invalid type for parameter ID" } } } } } }, "401": { "description": "401", "content": { "application/json": { "examples": { "Result": { "value": "" } } } } } }, "deprecated": false } } }, "x-readme": { "headers": [], "explorer-enabled": true, "proxy-enabled": true }, "x-readme-fauxas": true } ``` -------------------------------- ### Get all Competitors Source: https://developers.fireberry.com/reference/get-all-competitors Retrieves a list of all competitors. Supports pagination with `pagesize` and `pagenumber` query parameters. ```APIDOC ## GET /api/record/competitor ### Description Retrieves a list of all competitors. You can control the number of records per page and the page number using query parameters. ### Method GET ### Endpoint /api/record/competitor ### Parameters #### Query Parameters - **pagesize** (string) - Optional - The maximum number of records displayed per page, cannot exceed 50. Defaults to "50". - **pagenumber** (string) - Optional - The number of the page displayed, cannot exceed 10. Defaults to "1". ### Request Example ```json { "example": "" } ``` ### Response #### Success Response (200) - **success** (boolean) - Indicates if the request was successful. - **data** (object) - Contains the competitor data and pagination information. - **PrimaryKey** (string) - The primary key field for the data. - **PrimaryField** (string) - The primary field name. - **Total_Records** (integer) - The total number of records available. - **Page_Size** (integer) - The number of records per page. - **Page_Number** (integer) - The current page number. - **Records** (array) - An array containing data about all the account products including all their fields and values. - **message** (string) - A message associated with the response. #### Response Example ```json { "success": true, "data": { "PrimaryKey": "accountproductid", "PrimaryField": "productid", "Total_Records": 0, "Page_Size": 50, "Page_Number": 1, "Records": [Data about all of the account products including all their fields and values] }, "message": "" } ``` #### Error Response (400) - **Message** (string) - Describes the error, e.g., "Invalid Object Name". #### Error Response Example (400) ```json { "Message": "Invalid Object Name" } ``` ``` === COMPLETE CONTENT === This response contains all available snippets from this library. No additional content exists. Do not make further requests.