Actionstep Contact Notes API
The Contact Notes API from Actionstep — 2 operation(s) for contact 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-contact-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: Contact Notes API
description: For retrieving and managing contact notes. Please note for historic reasons contacts are often referred to as participants in Actionstep. 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: Contact Notes
paths:
/contactnotes:
get:
description: Returns a collection of contact notes.
tags:
- Contact Notes
responses:
'200':
description: OK.
content:
application/json:
schema:
$ref: '#/components/schemas/PagedContactNotes'
summary: Get contactnotes
x-summary-source: derived
operationId: getContactnotes
x-operation-id-source: derived
post:
description: Create a new contact note.
tags:
- Contact Notes
requestBody:
$ref: '#/components/requestBodies/CreateContactNote'
responses:
'200':
description: OK.
content:
application/json:
schema:
$ref: '#/components/schemas/ContactNote'
summary: Create contactnotes
x-summary-source: derived
operationId: postContactnotes
x-operation-id-source: derived
/contactnotes/{id}:
get:
description: Returns a single contact note.
tags:
- Contact Notes
parameters:
- name: id
in: path
description: Unique identifier for a contact note.
required: true
schema:
type: integer
format: int32
example: 9287
responses:
'200':
description: OK.
content:
application/json:
schema:
$ref: '#/components/schemas/ContactNote'
summary: Get contactnotes by id
x-summary-source: derived
operationId: getContactnotesById
x-operation-id-source: derived
put:
description: Update a contact note.
tags:
- Contact Notes
parameters:
- name: id
in: path
description: Unique identifier for a contact note.
required: true
schema:
type: integer
format: int32
example: 608
requestBody:
$ref: '#/components/requestBodies/UpdateContactNote'
responses:
'200':
description: OK.
content:
application/json:
schema:
$ref: '#/components/schemas/ContactNote'
summary: Replace contactnotes by id
x-summary-source: derived
operationId: putContactnotesById
x-operation-id-source: derived
delete:
description: Delete a contact note.
tags:
- Contact Notes
parameters:
- name: id
in: path
description: Unique identifier for a contact note.
required: true
schema:
type: integer
format: int32
example: 608
responses:
'204':
description: Success, No Content.
summary: Delete contactnotes by id
x-summary-source: derived
operationId: deleteContactnotesById
x-operation-id-source: derived
components:
schemas:
PagingData:
type: object
properties:
contactnotes:
$ref: '#/components/schemas/ContactNotesPageData'
ContactNoteLinks:
type: object
properties:
participant:
description: Unique identifier of the contact to whom this note is associated.
example: 546
type: integer
readOnly: true
CreateContactNoteLinks:
type: object
required:
- participant
properties:
participant:
description: Unique identifier of the contact to whom the note is associated.
example: 546
type: integer
PageMetaData:
type: object
properties:
paging:
$ref: '#/components/schemas/PagingData'
ContactNote:
type: object
properties:
id:
description: Unique identifier for the contact note.
example: 2347
type: integer
readOnly: true
enteredTimestamp:
description: The date and time the contact note is entered.
example: 2022-05-03 00:09:00+12:00
format: timestamp
type: string
readOnly: true
text:
description: Content of the contact note.
example: Please review AML status.
type: string
enteredBy:
description: The Actionstep user who entered the contact note.
example: Smith, John
type: string
readOnly: true
enteredByParticipant:
description: Unique identifier of the Actionstep user who created the contact note.
example: 842
type: integer
readOnly: true
source:
description: Indicates the source of the contact note.
enum:
- System
- User
example: User
type: string
noteTimestamp:
description: The date and time for the contact note.
example: 2023-06-03 00:09:30+12:00
format: timestamp
type: string
links:
$ref: '#/components/schemas/ContactNoteLinks'
PagedContactNotes:
type: object
properties:
contactnotes:
type: array
items:
$ref: '#/components/schemas/ContactNote'
meta:
$ref: '#/components/schemas/PageMetaData'
ContactNotesPageData:
type: object
properties:
recordCount:
description: The total number of contact 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 contact notes.
type: integer
example: 2
pageSize:
description: Page size.
type: integer
example: 50
prevPage:
description: A URL to the previous page of contact notes.
type: string
example: https://ap-southeast-2.actionstep.com/api/rest/contactnotes?page=1
nextPage:
description: A URL to the next page of contact notes.
type: string
example: https://ap-southeast-2.actionstep.com/api/rest/contactnotes?page=3
UpdateContactNoteLinks:
type: object
properties:
participant:
description: Unique identifier of the contact to whom the note is associated.
example: 546
type: integer
UpdateContactNote:
type: object
required:
- text
properties:
text:
description: Content of the contact note.
example: Updated address details.
type: string
noteTimestamp:
description: The date and time for the contact note.
example: 2023-06-03 00:09:30+12:00
format: timestamp
type: string
links:
$ref: '#/components/schemas/UpdateContactNoteLinks'
CreateContactNote:
type: object
required:
- text
properties:
text:
description: Content of the contact note.
example: Updated AML status notes.
type: string
source:
description: Indicates the source of the contact note.
enum:
- System
- User
example: User
type: string
noteTimestamp:
description: The date and time for the contact note.
example: 2023-06-03 00:09:30+12:00
format: timestamp
type: string
links:
$ref: '#/components/schemas/CreateContactNoteLinks'
requestBodies:
CreateContactNote:
content:
application/json:
schema:
$ref: '#/components/schemas/CreateContactNote'
UpdateContactNote:
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateContactNote'
externalDocs:
description: API Developer Portal - Constructing API Requests
url: https://docs.actionstep.com/api-requests/