Querying for notes

GET 
/api/v3/note

Available query parameter values for filtering:

• context_str (this should be one of: customer, billing_package, invoice, user, quote, item)
• context_id

Request

Query Parameters

where string

context_str:EQUALS:customer

order string

context_id:ASC

limit string

2

offset string

8

Responses

200

Object was fetched successfully

application/json

Schema

Schema

code integer
status string
message stringnullable
details objectnullable

response

object[]

Array [

note_id integer

Note ID #

user_id integer

User ID #

admin_id integer

Admin ID #

note string

Note text

note_is_pinned boolean

Whether or not the note was pinned

context_str string

The type of object the note is attached to

context_id string

The object ID # the note is attached to

note_datetime string

Date/time the note was created

]

Example (from schema)

{
  "code": 0,
  "status": "string",
  "message": "string",
  "details": {},
  "response": [
    {
      "note_id": 0,
      "user_id": 0,
      "admin_id": 0,
      "note": "string",
      "note_is_pinned": true,
      "context_str": "string",
      "context_id": "string",
      "note_datetime": "string"
    }
  ]
}

Example 1

{
  "code": 200,
  "status": "OK",
  "message": "",
  "details": {},
  "response": [
    {
      "note_id": 3,
      "user_id": null,
      "admin_id": 1,
      "note_is_pinned": false,
      "note_datetime": "2024-02-16 07:46:58",
      "note": "Customer agreed to upgrade to PRO plan.",
      "context_str": "customer",
      "context_id": 265
    },
    {
      "note_id": 4,
      "user_id": null,
      "admin_id": 1,
      "note_is_pinned": false,
      "note_datetime": "2024-02-16 07:47:14",
      "note": "Customer requested billing date be changed from 14th of the month to 12th of the month; credit issues.",
      "context_str": "customer",
      "context_id": 265
    }
  ]
}

400

Bad request

application/json

Schema

Schema

code integer
status string
message stringnullable
details objectnullable
response boolean

Example (from schema)

{
  "code": 0,
  "status": "string",
  "message": "string",
  "details": {},
  "response": true
}

Example 1

{
  "code": 400,
  "status": "Error",
  "message": "Missing or invalid parameter.",
  "details": {},
  "response": false
}

401

Authentication error

application/json

Schema

Schema

code integer
status string
message stringnullable
details objectnullable
response boolean

Example (from schema)

{
  "code": 0,
  "status": "string",
  "message": "string",
  "details": {},
  "response": true
}

Example 1

{
  "code": 401,
  "status": "Error",
  "message": "Invalid or incorrect authorization [Missing (basic) authorization header.]",
  "details": {},
  "response": false
}

Loading...