{
  "opencollection": "1.0.0",
  "info": {
    "name": "OAuth Token budgets notes API",
    "version": "1.0.0"
  },
  "items": [
    {
      "info": {
        "name": "notes",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Get notes",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.standardmetrics.io/notes/",
            "params": [
              {
                "name": "page",
                "value": "",
                "type": "query",
                "description": "A page number within the paginated result set."
              },
              {
                "name": "page_size",
                "value": "",
                "type": "query",
                "description": "Number of results to return per page."
              },
              {
                "name": "company_slug",
                "value": "",
                "type": "query",
                "description": "The slug that uniquely identifies the company whose metrics' to request. You can find the slug for a company by going to that company's portfolio page, and then the last portion of the URL will be the unique slug for said company. For example: in the url: `app.standardmetrics.io/venture/fund-slug/portfolio/example-slug/`, `example-slug` would the the slug. You can also make a request to the `/companies` endpoint to get a list of all your firm's companies and their slugs. Either the `company_slug` or `company_id` parameter must be passed to this endpoint."
              },
              {
                "name": "company_id",
                "value": "",
                "type": "query",
                "description": "The id for the company whose metrics' to request. You can get a company's id by making a request to the `/companies` endpoint. Either the `company_slug` or `company_id` parameter must be passed to this endpoint."
              },
              {
                "name": "sort_by",
                "value": "",
                "type": "query",
                "description": "The field to sort your query by. Currently, `created_at` is the only supported field. To sort in descending order, prepend the field you're sorting by with a `-`. Ascending order is implied, but you can also prepend the field you're sorting by with `+` to sort in ascending order. E.g. to sort by created_at in ascending order use `\"sort_by=-created_at\"` and to sort by created_at in descending order use `\"sort_by=+created_at\"` or just `\"sort_by=created_at\"`."
              }
            ]
          },
          "docs": "Retrieve all notes for a specific company. Notes are returned in markdown format.\n\n**Permissions:**\n- User must be authenticated via OAuth.\n- User must have access to the company."
        },
        {
          "info": {
            "name": "Create notes",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.standardmetrics.io/notes/",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Create new notes for a company. Supports creating multiple notes in a single request.\n\n**Notes:**:\n- All notes created must be for the same company.\n- `note` and `author_id` fields are required.\n- Either `company_id` or `company_slug` is required.\n\n**Permissions:**\n- User must be authenticated via OAuth.\n- User must have access to the company.\n- User must have ADMIN or EDITOR role."
        }
      ]
    }
  ],
  "bundled": true
}