Actionstep File Notes API
The File Notes API from Actionstep — 2 operation(s) for file notes.
Work with this as data
Every API here is available over the APIs.io API and to AI agents over MCP.
MCP server
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
Tools for apis
7 MCP tools reach this
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.
Call it yourself
curl for this page
This API
curl "https://apis.io/api/v1/apis/actionstep-file-notes-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"Discovery needs no key. Ratings and market analysis are Pro.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
OpenAPI Specification
openapi: 3.2.0
info:
title: File Notes API
description: For retrieving and managing file notes. For information of how to construct requests utilising fieldsets, sorting, paging, filters, and '*includes*', please refer to the API Developer Portal. E&OE.
version: '1.0'
tags:
- name: File Notes
paths:
/filenotes:
get:
description: Returns a collection of file notes.
tags:
- File Notes
responses:
'200':
description: OK.
content:
application/json:
schema:
$ref: '#/components/schemas/PagedFileNotes'
summary: Get filenotes
x-summary-source: derived
operationId: getFilenotes
x-operation-id-source: derived
post:
description: Create a new file note.
tags:
- File Notes
requestBody:
$ref: '#/components/requestBodies/CreateFileNote'
responses:
'200':
description: OK.
content:
application/json:
schema:
$ref: '#/components/schemas/FileNote'
summary: Create filenotes
x-summary-source: derived
operationId: postFilenotes
x-operation-id-source: derived
/filenotes/{id}:
get:
description: Returns a single file note.
tags:
- File Notes
parameters:
- name: id
in: path
description: Unique identifier for a file note.
required: true
schema:
type: integer
format: int32
example: 9287
responses:
'200':
description: OK.
content:
application/json:
schema:
$ref: '#/components/schemas/FileNote'
summary: Get filenotes by id
x-summary-source: derived
operationId: getFilenotesById
x-operation-id-source: derived
put:
description: Update a file note.
tags:
- File Notes
parameters:
- name: id
in: path
description: Unique identifier for a file note.
required: true
schema:
type: integer
format: int32
example: 608
requestBody:
$ref: '#/components/requestBodies/UpdateFileNote'
responses:
'200':
description: OK.
content:
application/json:
schema:
$ref: '#/components/schemas/FileNote'
summary: Replace filenotes by id
x-summary-source: derived
operationId: putFilenotesById
x-operation-id-source: derived
delete:
description: Delete a file note.
tags:
- File Notes
parameters:
- name: id
in: path
description: Unique identifier for a file note.
required: true
schema:
type: integer
format: int32
example: 608
responses:
'204':
description: Success, No Content.
summary: Delete filenotes by id
x-summary-source: derived
operationId: deleteFilenotesById
x-operation-id-source: derived
components:
schemas:
FileNote:
type: object
properties:
id:
description: Unique identifier for the file note.
example: 2347
type: integer
readOnly: true
enteredTimestamp:
description: The date and time the file note is entered.
example: 2022-05-03 00:09:00+12:00
format: timestamp
type: string
readOnly: true
text:
description: Content of the file note.
example: Client is requesting follow up meeting this week.
type: string
enteredBy:
description: The Actionstep user who entered the file note.
example: Smith, John
type: string
readOnly: true
source:
description: Indicates the source of the file note.
enum:
- System
- User
example: User
type: string
noteTimestamp:
description: The date and time for the file note.
example: 2023-06-03 00:09:30+12:00
format: timestamp
type: string
links:
$ref: '#/components/schemas/FileNoteLinks'
UpdateFileNote:
type: object
required:
- text
properties:
text:
description: Content of the file note.
example: Client is requesting follow up meeting this week.
type: string
noteTimestamp:
description: The date and time for the file note.
example: 2023-06-03 00:09:30+12:00
format: timestamp
type: string
links:
$ref: '#/components/schemas/UpdateFileNoteLinks'
PagingData:
type: object
properties:
filenotes:
$ref: '#/components/schemas/FileNotesPageData'
UpdateFileNoteLinks:
type: object
properties:
action:
description: Unique identifier of the matter to which the file note is associated.
example: 34
type: integer
document:
description: Unique identifier of a document associated to the file note.
example: 8376
type: integer
tags:
description: Zero or more tags to be associated with the file note. Each tag is the unique identifier for the tag. The supplied list of tags will replace in totality any existing tags. To remove all tags specify an empty array.
example:
- 1283
- 1934
type: array
items:
type: integer
CreateFileNoteLinks:
type: object
required:
- action
properties:
action:
description: Unique identifier of the matter to which the file note is associated.
example: 34
type: integer
document:
description: Unique identifier of a document associated to the file note.
example: 8376
type: integer
tags:
description: Zero or more tags to be associated with the file note. Each tag is the unique identifier for the tag.
example:
- 1283
- 1934
type: array
items:
type: integer
PageMetaData:
type: object
properties:
paging:
$ref: '#/components/schemas/PagingData'
CreateFileNote:
type: object
required:
- text
properties:
text:
description: Content of the file note.
example: Client is requesting follow up meeting this week.
type: string
source:
description: Indicates the source of the file note.
enum:
- System
- User
example: User
type: string
noteTimestamp:
description: The date and time for the file note.
example: 2023-06-03 00:09:30+12:00
format: timestamp
type: string
links:
$ref: '#/components/schemas/CreateFileNoteLinks'
FileNotesPageData:
type: object
properties:
recordCount:
description: The total number of file notes returned by the underlying query.
type: integer
example: 2487
pageCount:
description: The total number of pages generated by the underlying query.
type: integer
example: 50
page:
description: The page number for this page of file notes.
type: integer
example: 2
pageSize:
description: Page size.
type: integer
example: 50
prevPage:
description: A URL to the previous page of file notes.
type: string
example: https://ap-southeast-2.actionstep.com/api/rest/filenotes?page=1
nextPage:
description: A URL to the next page of file notes.
type: string
example: https://ap-southeast-2.actionstep.com/api/rest/filenotes?page=3
FileNoteLinks:
type: object
properties:
action:
description: Unique identifier of the matter to which the file note is associated.
example: 34
type: integer
document:
description: Unique identifier of a document associated to the file note.
example: 8376
type: integer
participant:
description: Unique identifier of the Actionstep user who created the file note.
example: 546
type: integer
readOnly: true
tags:
description: Zero or more tags associated with the file note. Each tag is the unique identifier for the tag.
example:
- 1283
- 1934
type: array
items:
type: integer
PagedFileNotes:
type: object
properties:
filenotes:
type: array
items:
$ref: '#/components/schemas/FileNote'
meta:
$ref: '#/components/schemas/PageMetaData'
requestBodies:
CreateFileNote:
content:
application/json:
schema:
$ref: '#/components/schemas/CreateFileNote'
UpdateFileNote:
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateFileNote'
externalDocs:
description: API Developer Portal - Constructing API Requests
url: https://docs.actionstep.com/api-requests/