Notes

Create Note

post

Authorizations

BearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

docIdstringRequired

The document ID

docTypestringRequired

The document type

Body

application/json

idstringOptional

The unique ID of the Note. Ignored when creating notes

notestring · nullableOptional

The content of the Note

Responses

200

Details about the new Note

application/json

idstringOptional

The unique ID of the Note. Ignored when creating notes

notestring · nullableOptional

The content of the Note

400

Bad Request

application/json

401

Not Authorized

application/json

404

Not found

application/json

500

Unexpected error

application/json

post/notes

HTTPcURLJavaScriptPython

POST /v2/notes?docId=text&docType=text HTTP/1.1
Host: openapi.paintscout.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 184

{
  "id": "abcd1234-abcd-1234-abcd-abcd1234abcd",
  "note": "This is a note content.",
  "owner": {
    "id": "user_abc123",
    "name": "Alice Smith"
  },
  "timestamp": {
    "created": 1672531200,
    "updated": 1672617600
  }
}

{
  "id": "abcd1234-abcd-1234-abcd-abcd1234abcd",
  "note": "This is a note content.",
  "owner": {
    "id": "user_abc123",
    "name": "Alice Smith"
  },
  "timestamp": {
    "created": 1672531200,
    "updated": 1672617600
  }
}

Retrieve Note

get

Authorizations

BearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idstringRequired

ID of the Note

Responses

200

Details about the note

application/json

idstringOptional

The unique ID of the Note. Ignored when creating notes

notestring · nullableOptional

The content of the Note

400

Bad Request

application/json

401

Not Authorized

application/json

404

Not found

application/json

500

Unexpected error

application/json

get/notes/{id}

HTTPcURLJavaScriptPython

GET /v2/notes/{id} HTTP/1.1
Host: openapi.paintscout.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "id": "abcd1234-abcd-1234-abcd-abcd1234abcd",
  "note": "This is a note content.",
  "owner": {
    "id": "user_abc123",
    "name": "Alice Smith"
  },
  "timestamp": {
    "created": 1672531200,
    "updated": 1672617600
  }
}