Erply note API
The note API from Erply — 2 operation(s) for note.
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/erply-note-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"Discovery needs no key. Ratings and market analysis are Pro.
OpenAPI Specification
openapi: 3.2.0
info:
description: "\n\n## Overview\n\n\n\nThis application offers an API for managing assignments and tasks.\n\n\n\nGraphQL endpoint for the same API is [also available](/graph)\n\n\n\n<details><summary>Authentication</summary>\n\n\n\n> \n\n> Authenticate using your Erply credentials and get a sessionKey. This sessionKey and your Erply clientCode must be provided in the HTTP headers of every request. You do not have to authenticate against this API - valid Erply sessionKey-s from other sources are also acceptable. To authenticate using this API, use the `POST /api/v1/auth` endpoint.\n\n>\n\n</details>\n\n"
title: assignments Assortment Note API
contact: {}
version: 2.36.5
tags:
- name: note
paths:
/api/v1/note:
get:
security:
- ErplyClientCode: []
- ErplySession: []
- ErplyJWT: []
- AccessToken: []
tags:
- note
summary: Look up notes
parameters:
- description: Note ids
name: noteId
in: query
style: form
explode: false
schema:
type: array
items:
type: integer
- description: Workorder ids
name: workorderId
in: query
style: form
explode: false
schema:
type: array
items:
type: integer
- description: Item ids
name: itemId
in: query
style: form
explode: false
schema:
type: array
items:
type: integer
- description: Row ids
name: rowId
in: query
style: form
explode: false
schema:
type: array
items:
type: integer
- description: Task ids
name: taskId
in: query
style: form
explode: false
schema:
type: array
items:
type: integer
- description: Note types to return. Defaults to returning the `type` that correspond to the provided ID filter. Eg. when `rowId` is defined, row notes are returned etc
name: type
in: query
style: form
explode: false
schema:
type: array
items:
enum:
- workorder
- item
- row
- task
type: string
- description: If total matching record count should be return in response header
name: withTotalCount
in: query
schema:
type: boolean
- description: Result page size
name: pageSize
in: query
schema:
type: integer
- description: Result page number
name: pageNr
in: query
schema:
type: integer
- description: Sorting order
name: sort
in: query
schema:
type: string
responses:
'200':
description: OK
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/NoteResponse'
'401':
description: Forbidden
'500':
description: Internal Server Error
post:
security:
- ErplyClientCode: []
- ErplySession: []
- ErplyJWT: []
- AccessToken: []
tags:
- note
summary: Add a new note record
responses:
'201':
description: Created
content:
application/json:
schema:
$ref: '#/components/schemas/NoteResponse'
'400':
description: Bad Request
'401':
description: Forbidden
'500':
description: Internal Server Error
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/NoteRequest'
description: Note record
required: true
/api/v1/note/{noteId}:
delete:
security:
- ErplyClientCode: []
- ErplySession: []
- ErplyJWT: []
- AccessToken: []
tags:
- note
summary: Delete one note record
parameters:
- description: Note id
name: noteId
in: path
required: true
schema:
type: integer
responses:
'200':
description: OK
'400':
description: Bad Request
'401':
description: Forbidden
'404':
description: Not Found
'500':
description: Internal Server Error
patch:
security:
- ErplyClientCode: []
- ErplySession: []
- ErplyJWT: []
- AccessToken: []
tags:
- note
summary: Update note record
parameters:
- description: Note id
name: noteId
in: path
required: true
schema:
type: integer
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/NoteResponse'
'400':
description: Bad Request
'401':
description: Forbidden
'404':
description: Not Found
'500':
description: Internal Server Error
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/NoteRequest'
description: Note record
required: true
components:
schemas:
NoteRequest:
type: object
properties:
data:
type: object
id:
type: integer
itemId:
type: integer
rowId:
type: integer
taskId:
type: integer
text:
type: string
workorderId:
type: integer
NoteResponse:
type: object
properties:
createdAt:
type: string
createdById:
type: integer
data:
type: object
id:
type: integer
itemId:
type: integer
rowId:
type: integer
taskId:
type: integer
text:
type: string
type:
type: string
updatedAt:
type: string
updatedById:
type: integer
workorderId:
type: integer
securitySchemes:
AccessToken:
type: apiKey
name: accessToken
in: header
ErplyClientCode:
type: apiKey
name: clientCode
in: header
ErplyJWT:
type: apiKey
name: jwt
in: header
ErplySession:
type: apiKey
name: sessionKey
in: header
RequestKey:
type: apiKey
name: requestKey
in: header