Skip to main content
POST
/
notes
Create a note
curl --request POST \
  --url https://api.gospott.com/notes \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "title": "<string>",
  "content": "<string>",
  "links": [
    {
      "entityId": "<string>"
    }
  ],
  "meetingId": "<string>",
  "labelIds": [
    "<string>"
  ]
}
'
{
  "id": "<string>",
  "title": "<string>",
  "content": "<string>",
  "createdAt": "2023-11-07T05:31:56Z",
  "lastEditedAt": "2023-11-07T05:31:56Z",
  "createdBy": {
    "id": "<string>",
    "name": "<string>",
    "avatarUrl": "<string>",
    "deactivatedAt": "2023-11-07T05:31:56Z"
  },
  "editors": [
    {
      "editedBy": {
        "id": "<string>",
        "name": "<string>",
        "avatarUrl": "<string>",
        "deactivatedAt": "2023-11-07T05:31:56Z"
      },
      "editedAt": "2023-11-07T05:31:56Z"
    }
  ],
  "links": [
    {
      "id": "<string>",
      "noteId": "<string>",
      "candidate": {
        "id": "<string>",
        "firstName": "<string>",
        "lastName": "<string>",
        "middleName": "<string>",
        "secondLastName": "<string>",
        "avatarUrl": "<string>"
      }
    }
  ],
  "meeting": {
    "id": "<string>",
    "title": "<string>",
    "startTime": "2023-11-07T05:31:56Z",
    "endTime": "2023-11-07T05:31:56Z",
    "hasTranscript": true
  },
  "call": {
    "id": "<string>",
    "startTime": "2023-11-07T05:31:56Z",
    "endTime": "2023-11-07T05:31:56Z",
    "hasTranscript": true
  },
  "audioRecording": {
    "id": "<string>",
    "startTime": "2023-11-07T05:31:56Z",
    "endTime": "2023-11-07T05:31:56Z",
    "hasTranscript": true
  },
  "pinned": true,
  "shouldPoll": true,
  "labels": [
    {
      "id": "<string>",
      "name": "<string>",
      "colorHex": "<string>"
    }
  ]
}

Documentation Index

Fetch the complete documentation index at: https://api-docs.spott.io/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
x-api-key
string
header
required

API key for authentication. Get your API key from Settings → API Keys in your Spott dashboard.

Body

application/json
​
title
string | null
required
​
content
string
required

The content of the note in HTML format.

​
source
enum<string>
Available options:
phone,
inPerson,
onlineMeeting,
callAttempted
​
links
object[]
​
meetingId
string
​
labelIds
string[]

Response

Note created successfully.

​
id
string
required
​
title
string | null
required
​
content
string
required
​
createdAt
required
Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$
​
lastEditedAt
required
Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$
​
createdBy
object
required
​
editors
object[]
required
​
links
object[]
required
​
meeting
object
required
​
call
object
required
​
audioRecording
object
required
​
type
enum<string>
required
Available options:
manual,
aiSummary
​
source
enum<string> | null
required
Available options:
phone,
inPerson,
onlineMeeting,
callAttempted
​
pinned
boolean
required
​
shouldPoll
boolean
required
​
labels
object[]
required