{
  "opencollection": "1.0.0",
  "info": {
    "name": "ChartHop access field API",
    "version": "V1.0.0"
  },
  "items": [
    {
      "info": {
        "name": "field",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Return all fields in the organization paginated",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/v1/org/:orgId/field",
            "params": [
              {
                "name": "orgId",
                "value": "",
                "type": "path",
                "description": "Org identifier (either id or slug)"
              },
              {
                "name": "from",
                "value": "",
                "type": "query",
                "description": "Field id to start paginating from"
              },
              {
                "name": "limit",
                "value": "",
                "type": "query",
                "description": "Number of results to return"
              },
              {
                "name": "ids",
                "value": "",
                "type": "query",
                "description": "Comma separated Field Ids to find"
              },
              {
                "name": "table",
                "value": "",
                "type": "query",
                "description": "Retrieve fields from a particular table (id or name); if not passed, returns non-table fields"
              },
              {
                "name": "tableType",
                "value": "",
                "type": "query",
                "description": "Retrieve fields from a particular table type; ignored if table not passed"
              },
              {
                "name": "form",
                "value": "",
                "type": "query",
                "description": "Retrieve fields relating to a particular form"
              },
              {
                "name": "builtin",
                "value": "",
                "type": "query",
                "description": "Include built-in (builtin), custom (custom) or all fields - defaults to custom"
              },
              {
                "name": "includeTtst",
                "value": "",
                "type": "query",
                "description": "Include custom ttst fields - defaults to false"
              }
            ]
          },
          "docs": "Return all fields in the organization paginated"
        },
        {
          "info": {
            "name": "Create a field",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "{{baseUrl}}/v1/org/:orgId/field",
            "params": [
              {
                "name": "orgId",
                "value": "",
                "type": "path",
                "description": "Org identifier (either id or slug)"
              },
              {
                "name": "tableType",
                "value": "",
                "type": "query",
                "description": "table type to add the field to"
              }
            ]
          },
          "docs": "Create a field"
        },
        {
          "info": {
            "name": "Get built-in fields",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/v1/org/:orgId/field/built-in",
            "params": [
              {
                "name": "orgId",
                "value": "",
                "type": "path",
                "description": "Org identifier (either id or slug)"
              }
            ]
          },
          "docs": "Get built-in fields"
        },
        {
          "info": {
            "name": "Return uncategorized fields",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/v1/org/:orgId/field/category",
            "params": [
              {
                "name": "orgId",
                "value": "",
                "type": "path",
                "description": "Org identifier (either id or slug)"
              }
            ]
          },
          "docs": "Return uncategorized fields"
        },
        {
          "info": {
            "name": "Return fields in a particular category",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/v1/org/:orgId/field/category/:categoryId",
            "params": [
              {
                "name": "orgId",
                "value": "",
                "type": "path",
                "description": "Org identifier (either id or slug)"
              },
              {
                "name": "categoryId",
                "value": "",
                "type": "path",
                "description": "Category id"
              }
            ]
          },
          "docs": "Return fields in a particular category"
        },
        {
          "info": {
            "name": "Delete fields",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "{{baseUrl}}/v1/org/:orgId/field/delete",
            "params": [
              {
                "name": "orgId",
                "value": "",
                "type": "path",
                "description": "Org identifier (either id or slug)"
              }
            ]
          },
          "docs": "Delete fields"
        },
        {
          "info": {
            "name": "Remove field from all associated categories",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "{{baseUrl}}/v1/org/:orgId/field/remove-category",
            "params": [
              {
                "name": "orgId",
                "value": "",
                "type": "path",
                "description": "Org identifier (either id or slug)"
              }
            ]
          },
          "docs": "Remove field from all associated categories"
        },
        {
          "info": {
            "name": "Remove overrides from fields",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "{{baseUrl}}/v1/org/:orgId/field/remove-overrides",
            "params": [
              {
                "name": "orgId",
                "value": "",
                "type": "path",
                "description": "Org identifier (either id or slug)"
              }
            ]
          },
          "docs": "Remove overrides from fields"
        },
        {
          "info": {
            "name": "Update status for existing fields",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "{{baseUrl}}/v1/org/:orgId/field/status",
            "params": [
              {
                "name": "orgId",
                "value": "",
                "type": "path",
                "description": "Org identifier (either id or slug)"
              }
            ]
          },
          "docs": "Update status for existing fields"
        },
        {
          "info": {
            "name": "Return a particular field by id",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/v1/org/:orgId/field/:fieldId",
            "params": [
              {
                "name": "orgId",
                "value": "",
                "type": "path",
                "description": "Org identifier (either id or slug)"
              },
              {
                "name": "fieldId",
                "value": "",
                "type": "path",
                "description": "Field id"
              }
            ]
          },
          "docs": "Return a particular field by id"
        },
        {
          "info": {
            "name": "Update an existing field",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "{{baseUrl}}/v1/org/:orgId/field/:fieldId",
            "params": [
              {
                "name": "orgId",
                "value": "",
                "type": "path",
                "description": "Org identifier (either id or slug)"
              },
              {
                "name": "fieldId",
                "value": "",
                "type": "path",
                "description": "Field id"
              }
            ]
          },
          "docs": "Update an existing field"
        },
        {
          "info": {
            "name": "Delete a field",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "{{baseUrl}}/v1/org/:orgId/field/:fieldId",
            "params": [
              {
                "name": "orgId",
                "value": "",
                "type": "path",
                "description": "Org identifier (either id or slug)"
              },
              {
                "name": "fieldId",
                "value": "",
                "type": "path",
                "description": "Field id"
              }
            ]
          },
          "docs": "Delete a field"
        },
        {
          "info": {
            "name": "Perform a dry-run of an update to an existing field that will require migrations",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "{{baseUrl}}/v1/org/:orgId/field/:fieldId/dryrun",
            "params": [
              {
                "name": "orgId",
                "value": "",
                "type": "path",
                "description": "Org identifier (either id or slug)"
              },
              {
                "name": "fieldId",
                "value": "",
                "type": "path",
                "description": "Field id"
              }
            ]
          },
          "docs": "Perform a dry-run of an update to an existing field that will require migrations"
        }
      ]
    }
  ],
  "bundled": true
}