{
  "opencollection": "1.0.0",
  "info": {
    "name": "Canoe API v1 Terms API",
    "version": "1.0.0"
  },
  "request": {
    "auth": {
      "type": "bearer",
      "token": "{{bearerToken}}"
    }
  },
  "items": [
    {
      "info": {
        "name": "Terms",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Get Terms",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.canoesoftware.com/v1/terms",
            "params": [
              {
                "name": "term_id",
                "value": "",
                "type": "query",
                "description": "Specifying one or more IDs returns the specified Term(s)."
              },
              {
                "name": "name",
                "value": "",
                "type": "query",
                "description": "The name of the Term.  This can either be the formal Term name or any of its associated aliases. To search based on a part of the fund name or alias, append an asterisk * character anywhere within the name parameter.  For example, searching Series* returns all Terms with names starting with Series."
              },
              {
                "name": "fund_name",
                "value": "",
                "type": "query",
                "description": "Specifying a Fund name returns the Term(s) associated with the Fund.  This can either be the formal Fund name or any of its associated aliases.  To search based on a part of the Fund name or alias, append an asterisk * character anywhere within the name parameter.  For example, searching *LP returns all Terms associated with Fund names ending with LP."
              },
              {
                "name": "fund_id",
                "value": "",
                "type": "query",
                "description": "Specifying one or more IDs returns the Term(s) associated with the specified Fund(s)."
              },
              {
                "name": "custom_field",
                "value": "",
                "type": "query",
                "description": "An indexed string of one or more custom field IDs, which relate to term specific custom fields, and one or more custom field values for each. Specify the custom field ID and then the custom field value(s). When filtering on multiple values, separate them by commas.  Filter on additional custom fields by separating with an ampersand. Example:- /v1/funds?custom_field[bfa7ec21-9a73-4640-03b2-0e32aa1ae8a6]=value1,value2&custom_field[867e4563-c2b5-e788-d050-4ce151dec635]=value1"
              },
              {
                "name": "page",
                "value": "",
                "type": "query",
                "description": "This page of results to retrieve.  For example, if you specify \"2\" you will receive all Terms on page 2.  The default is 1."
              },
              {
                "name": "perPage",
                "value": "",
                "type": "query",
                "description": "The number of Terms for each paginated download. The default is 100."
              },
              {
                "name": "fields",
                "value": "",
                "type": "query",
                "description": "The fields you need in the partial response. The value of the fields parameter must be a comma-separated (U+002C COMMA, \",\") list that refers to the name(s) of the fields to be returned."
              }
            ]
          },
          "docs": "Fetch all terms accessible by the current API user."
        },
        {
          "info": {
            "name": "Create A Single Term",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.canoesoftware.com/v1/terms",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Create a new term based on the input parameters."
        },
        {
          "info": {
            "name": "Update A Single Term",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://api.canoesoftware.com/v1/terms/:id",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "The id of the term to edit."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Update the specified term based on the input parameters."
        },
        {
          "info": {
            "name": "Delete A Single Term",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://api.canoesoftware.com/v1/terms/:id",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "The id of the Term to delete.  Note that the final Term on a Fund cannot be deleted.  Use PUT v1/terms/{id} to update the Term or use DELETE v1/funds/{id} to delete the Fund, which will also delete the Term.  WARNING - This will delete the term as well as it's associated documents and allocations."
              }
            ]
          },
          "docs": "Delete a single term based on the term's id."
        }
      ]
    }
  ],
  "bundled": true
}