{
  "opencollection": "1.0.0",
  "info": {
    "name": "HubSpot CRM Engagement Notes API",
    "version": "3.0.0"
  },
  "items": [
    {
      "info": {
        "name": "Basic Operations",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Hubspot List All Notes",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.hubapi.com/crm/v3/objects/notes",
            "params": [
              {
                "name": "limit",
                "value": "",
                "type": "query",
                "description": "Maximum number of results per page"
              },
              {
                "name": "after",
                "value": "",
                "type": "query",
                "description": "Pagination cursor from previous response"
              },
              {
                "name": "properties",
                "value": "",
                "type": "query",
                "description": "Comma-separated list of properties to return"
              },
              {
                "name": "propertiesWithHistory",
                "value": "",
                "type": "query",
                "description": "Comma-separated list of properties to return with history"
              },
              {
                "name": "associations",
                "value": "",
                "type": "query",
                "description": "Comma-separated list of association types to retrieve"
              },
              {
                "name": "archived",
                "value": "",
                "type": "query",
                "description": "Whether to include archived notes"
              }
            ],
            "auth": {
              "type": "oauth2",
              "flow": "authorization_code",
              "authorizationUrl": "https://app.hubspot.com/oauth/authorize",
              "accessTokenUrl": "https://api.hubapi.com/oauth/v1/token",
              "credentials": {
                "clientId": "{{clientId}}",
                "clientSecret": "{{clientSecret}}"
              }
            }
          },
          "docs": "Returns a paginated list of all note engagements in the CRM.\nUse query parameters to filter by properties, limit results, and paginate through records.\n"
        },
        {
          "info": {
            "name": "Hubspot Create a Note",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.hubapi.com/crm/v3/objects/notes",
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "oauth2",
              "flow": "authorization_code",
              "authorizationUrl": "https://app.hubspot.com/oauth/authorize",
              "accessTokenUrl": "https://api.hubapi.com/oauth/v1/token",
              "credentials": {
                "clientId": "{{clientId}}",
                "clientSecret": "{{clientSecret}}"
              }
            }
          },
          "docs": "Creates a new note engagement in the CRM.\nYou can specify note properties and optionally associate the note with other CRM objects.\n"
        },
        {
          "info": {
            "name": "Hubspot Get a Note by Id",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.hubapi.com/crm/v3/objects/notes/:noteId",
            "params": [
              {
                "name": "noteId",
                "value": "1024",
                "type": "path",
                "description": "The unique identifier of the note"
              },
              {
                "name": "properties",
                "value": "",
                "type": "query",
                "description": "Comma-separated list of properties to return"
              },
              {
                "name": "propertiesWithHistory",
                "value": "",
                "type": "query",
                "description": "Comma-separated list of properties to return with history"
              },
              {
                "name": "associations",
                "value": "",
                "type": "query",
                "description": "Comma-separated list of association types to retrieve"
              },
              {
                "name": "archived",
                "value": "",
                "type": "query",
                "description": "Whether to include archived notes"
              }
            ],
            "auth": {
              "type": "oauth2",
              "flow": "authorization_code",
              "authorizationUrl": "https://app.hubspot.com/oauth/authorize",
              "accessTokenUrl": "https://api.hubapi.com/oauth/v1/token",
              "credentials": {
                "clientId": "{{clientId}}",
                "clientSecret": "{{clientSecret}}"
              }
            }
          },
          "docs": "Retrieves a single note engagement by its unique identifier.\nOptionally include specific properties, property history, and associations.\n"
        },
        {
          "info": {
            "name": "Hubspot Update a Note",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "https://api.hubapi.com/crm/v3/objects/notes/:noteId",
            "params": [
              {
                "name": "noteId",
                "value": "1024",
                "type": "path",
                "description": "The unique identifier of the note"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "oauth2",
              "flow": "authorization_code",
              "authorizationUrl": "https://app.hubspot.com/oauth/authorize",
              "accessTokenUrl": "https://api.hubapi.com/oauth/v1/token",
              "credentials": {
                "clientId": "{{clientId}}",
                "clientSecret": "{{clientSecret}}"
              }
            }
          },
          "docs": "Updates an existing note engagement with new property values.\nOnly the properties specified in the request body will be updated.\n"
        },
        {
          "info": {
            "name": "Hubspot Archive a Note",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://api.hubapi.com/crm/v3/objects/notes/:noteId",
            "params": [
              {
                "name": "noteId",
                "value": "1024",
                "type": "path",
                "description": "The unique identifier of the note"
              }
            ],
            "auth": {
              "type": "oauth2",
              "flow": "authorization_code",
              "authorizationUrl": "https://app.hubspot.com/oauth/authorize",
              "accessTokenUrl": "https://api.hubapi.com/oauth/v1/token",
              "credentials": {
                "clientId": "{{clientId}}",
                "clientSecret": "{{clientSecret}}"
              }
            }
          },
          "docs": "Archives (soft deletes) a note engagement by moving it to the recycling bin.\nArchived notes can be restored within 90 days.\n"
        }
      ]
    },
    {
      "info": {
        "name": "Batch Operations",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Hubspot Create a Batch of Notes",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.hubapi.com/crm/v3/objects/notes/batch/create",
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "oauth2",
              "flow": "authorization_code",
              "authorizationUrl": "https://app.hubspot.com/oauth/authorize",
              "accessTokenUrl": "https://api.hubapi.com/oauth/v1/token",
              "credentials": {
                "clientId": "{{clientId}}",
                "clientSecret": "{{clientSecret}}"
              }
            }
          },
          "docs": "Creates multiple note engagements in a single request.\nEach note can have its own properties and associations.\nMaximum of 100 notes per batch request.\n"
        },
        {
          "info": {
            "name": "Hubspot Read a Batch of Notes",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.hubapi.com/crm/v3/objects/notes/batch/read",
            "params": [
              {
                "name": "archived",
                "value": "",
                "type": "query",
                "description": "Whether to include archived notes"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "oauth2",
              "flow": "authorization_code",
              "authorizationUrl": "https://app.hubspot.com/oauth/authorize",
              "accessTokenUrl": "https://api.hubapi.com/oauth/v1/token",
              "credentials": {
                "clientId": "{{clientId}}",
                "clientSecret": "{{clientSecret}}"
              }
            }
          },
          "docs": "Retrieves multiple note engagements by their IDs or a unique property value.\nMaximum of 100 notes per batch request.\n"
        },
        {
          "info": {
            "name": "Hubspot Update a Batch of Notes",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.hubapi.com/crm/v3/objects/notes/batch/update",
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "oauth2",
              "flow": "authorization_code",
              "authorizationUrl": "https://app.hubspot.com/oauth/authorize",
              "accessTokenUrl": "https://api.hubapi.com/oauth/v1/token",
              "credentials": {
                "clientId": "{{clientId}}",
                "clientSecret": "{{clientSecret}}"
              }
            }
          },
          "docs": "Updates multiple note engagements in a single request.\nEach note update must include the note ID and the properties to update.\nMaximum of 100 notes per batch request.\n"
        },
        {
          "info": {
            "name": "Hubspot Archive a Batch of Notes",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.hubapi.com/crm/v3/objects/notes/batch/archive",
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "oauth2",
              "flow": "authorization_code",
              "authorizationUrl": "https://app.hubspot.com/oauth/authorize",
              "accessTokenUrl": "https://api.hubapi.com/oauth/v1/token",
              "credentials": {
                "clientId": "{{clientId}}",
                "clientSecret": "{{clientSecret}}"
              }
            }
          },
          "docs": "Archives (soft deletes) multiple note engagements in a single request.\nMaximum of 100 notes per batch request.\n"
        }
      ]
    },
    {
      "info": {
        "name": "Search",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Hubspot Search Notes",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.hubapi.com/crm/v3/objects/notes/search",
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "oauth2",
              "flow": "authorization_code",
              "authorizationUrl": "https://app.hubspot.com/oauth/authorize",
              "accessTokenUrl": "https://api.hubapi.com/oauth/v1/token",
              "credentials": {
                "clientId": "{{clientId}}",
                "clientSecret": "{{clientSecret}}"
              }
            }
          },
          "docs": "Searches for note engagements using filters, property values, and full-text search.\nSupports complex filter groups with AND/OR logic.\n"
        }
      ]
    },
    {
      "info": {
        "name": "GDPR Compliance",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Hubspot Permanently Delete a Note for Gdpr Compliance",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.hubapi.com/crm/v3/objects/notes/gdpr-delete",
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "oauth2",
              "flow": "authorization_code",
              "authorizationUrl": "https://app.hubspot.com/oauth/authorize",
              "accessTokenUrl": "https://api.hubapi.com/oauth/v1/token",
              "credentials": {
                "clientId": "{{clientId}}",
                "clientSecret": "{{clientSecret}}"
              }
            }
          },
          "docs": "Permanently deletes a note engagement for GDPR compliance.\nThis action cannot be undone. Use this endpoint when you need to comply with a data subject's right to erasure request.\n"
        }
      ]
    }
  ],
  "bundled": true
}