{
  "opencollection": "1.0.0",
  "info": {
    "name": "Canoe API v1 Organizations API",
    "version": "1.0.0"
  },
  "request": {
    "auth": {
      "type": "bearer",
      "token": "{{bearerToken}}"
    }
  },
  "items": [
    {
      "info": {
        "name": "Organizations",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Get Organizations",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.canoesoftware.com/v1/organizations",
            "params": [
              {
                "name": "page",
                "value": "",
                "type": "query",
                "description": "This page number. For example, if you specify \"2\" you will see all organizations on page 2. By default, this is set to 1. <u>This parameter is only valid if the X-API-VERSION header is set to 2023-08-07.</u>"
              },
              {
                "name": "limit",
                "value": "",
                "type": "query",
                "description": "The number of Organizations for each paginated download. The default is 100."
              },
              {
                "name": "organization_id",
                "value": "",
                "type": "query",
                "description": "This is the entity or account ID you would like to search for. When filtering on multiple values, separate them by commas."
              },
              {
                "name": "entity_custom_field",
                "value": "",
                "type": "query",
                "description": "An indexed string of one or more custom field IDs, which relate to entity 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/organizations?entity_custom_field[bfa7ec21-9a73-4640-03b2-0e32aa1ae8a6]=value1,value2&entity_custom_field[867e4563-c2b5-e788-d050-4ce151dec635]=value1"
              },
              {
                "name": "type",
                "value": "",
                "type": "query",
                "description": "The type of organizations to return. Available types are 'account' and 'entity'. Defaults to both types."
              },
              {
                "name": "name",
                "value": "",
                "type": "query",
                "description": "The names of the accounts or entities you wish to retrieve records for. When filtering for entities this can either be the formal entity name or any of its associated aliases. To search based on a part of an account name or part of an entity name or alias, just append an \"*\" character anywhere within the name parameter."
              }
            ]
          },
          "docs": "Get your organizations user info\n\n<span name=\"doc-alert-info\">\nThis endpoint offers optional pagination. \nPagination supports the return of large results and is highly recommended for all use cases. \nUnpaginated calls will be depreciated in future versions of the Canoe API.\n<br><br>\nWhen using pagination, the response will contain headers defining the <code>total</code> number of results, \nas well as the <code>first</code>, <code>next</code>, <code>prev</code>, and <code>last</code> page respons"
        },
        {
          "info": {
            "name": "Get A Single Organization",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.canoesoftware.com/v1/organizations/:id",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "The id of the organization."
              }
            ]
          },
          "docs": "Fetch organization by the organization's ID"
        },
        {
          "info": {
            "name": "Get A Single Organization's Document Data",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.canoesoftware.com/v1/organizations/:id/document-data",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "The id of the organization."
              },
              {
                "name": "page",
                "value": "",
                "type": "query",
                "description": "This page number. For example, if you specify \"2\" you will see all documents on page 2. By default, this is set to 1. <u>This parameter is only valid if the X-API-VERSION header is set to 2024-10-07.</u> Example: 1"
              },
              {
                "name": "limit",
                "value": "",
                "type": "query",
                "description": "The number of documents for each page. The maximum number of documents limit is 100. <u>This parameter is only valid if the X-API-VERSION header is set to 2024-10-07.</u> Example: 50"
              },
              {
                "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."
              },
              {
                "name": "category",
                "value": "",
                "type": "query",
                "description": "The category of the document. Our current categories are:<br><br><li>Capital Activity</li><br><li>Email & System Messages</li><br><li>Financial Statements & Performance</li><br><li>Investment & Transactional</li><br><li>Investor Administration & Communication</li><br><li>Legal, Compliance & Regulatory</li><br><li>Other</li><br><li>Tax</li><br><br>Multiple categories can be passed as a comma-delimited list (e.g. <code>Capital Activity,Tax</code>)."
              }
            ]
          },
          "docs": "Fetch the extracted data and metadata of a single organization's documents.\n\n<span name=\"doc-alert-info\">\nThis endpoint offers optional pagination.\nPagination supports the return of large results and is highly recommended for all use cases.\nUnpaginated calls will be depreciated in future versions of the Canoe API.\n<br><br>\nWhen using pagination, the response will contain headers defining the <code>total</code> number of results,\nas well as the <code>first</code>, <code>next</code>, <code>prev</c"
        },
        {
          "info": {
            "name": "Download A Single Organization's Documents",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.canoesoftware.com/v1/organizations/:id/documents",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "The id of the organization."
              },
              {
                "name": "start_time",
                "value": "",
                "type": "query",
                "description": "All documents downloaded will have an uploaded timestamp greater than or equal to the given start_time. Unless otherwise specified, the timestamp will be in EST (Eastern Standard Time). We suggest using the ISO 8601 format for the parameter. For example, '2019-09-18T00:00:00-07:00' represents the time in Pacific Daylight Time; this will be automatically converted to EST. In this case, the user will receive the documents uploaded on or after 2019-09-19 at 03:00:00."
              },
              {
                "name": "page",
                "value": "",
                "type": "query",
                "description": "This page number corresponds with the pagination in Canoe's Intelligent Document Center. There are up to 100 documents on each page. For example, if you specify \"2\" you will see all of an Organization's documents on page 2. By default, this is set to 1."
              },
              {
                "name": "limit",
                "value": "",
                "type": "query",
                "description": "The number of documents for each download. The maximum number of documents as well as the default is 100."
              },
              {
                "name": "file_name_type",
                "value": "",
                "type": "query",
                "description": "The document attribute to use for the file name. Available options are name, original_file_name and id. The default value for this is name."
              }
            ]
          },
          "docs": "Download a specific Organization's documents in a ZIP file. Each fetch will download up to 100 documents. By default, this will fetch the first 100 documents in the Intelligent Document Center. A successful call to this endpoint will only contain the binary file and not the JSON data."
        },
        {
          "info": {
            "name": "Get A Single Organization's Document IDs",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.canoesoftware.com/v1/organizations/:id/document-ids",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "The id of the organization."
              },
              {
                "name": "start_time",
                "value": "",
                "type": "query",
                "description": "All document IDs returned will have an uploaded timestamp greater than or equal to the given start_time. Unless otherwise specified, the timestamp will be in EST (Eastern Standard Time). We suggest using the ISO 8601 format for the parameter. For example, '2019-09-18T00:00:00-07:00' represents the time in Pacific Daylight Time; this will be automatically converted to EST. In this case, the user will receive the documents uploaded on or after 2019-09-19 at 03:00:00."
              }
            ]
          },
          "docs": "Get a specific organization's document IDs for downloading the documents one by one."
        },
        {
          "info": {
            "name": "Create A Single Entity",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.canoesoftware.com/v1/organizations/entities",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Create a new entity based on the input parameters."
        },
        {
          "info": {
            "name": "Update A Single Entity",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://api.canoesoftware.com/v1/organizations/entities/:id",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "The id of the entity."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Update an existing entity based on the input parameters."
        },
        {
          "info": {
            "name": "Create A Single Account",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.canoesoftware.com/v1/organizations/accounts",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Create a new account based on the input parameters."
        },
        {
          "info": {
            "name": "Update A Single Account",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://api.canoesoftware.com/v1/organizations/accounts/:id",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "The id of the account."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Update an existing account based on the input parameters."
        }
      ]
    }
  ],
  "bundled": true
}