List notes

Needs: Clients, Read

Returns a client's notes as the Notes tab shows them: General, Task and Appointment notes, with their submissions, template answers and shift cautions. Newest first, 25 per page. General and task notes have refs such as general:12 or task:34, which you can pass to the edit a note endpoint.

Note: next_cursor is left out on the last page. filter_options, the values the filters accept, is included on the first page only. The note objects are the same ones the Notes tab shows, so they are not repeated here.

curl -X GET "https://app.imploy.com.au/api/integrations/v1/clients/123/notes?search=example_string&filters=%5B%22null%22%5D&from=example_string&to=example_string&limit=42&cursor=example_string" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_TOKEN"

import requests
import json

url = "https://app.imploy.com.au/api/integrations/v1/clients/123/notes?search=example_string&filters=%5B%22null%22%5D&from=example_string&to=example_string&limit=42&cursor=example_string"
headers = {
  "Content-Type": "application/json",
  "Authorization": "Bearer YOUR_API_TOKEN"
}

response = requests.get(url, headers=headers)
print(response.json())

const response = await fetch("https://app.imploy.com.au/api/integrations/v1/clients/123/notes?search=example_string&filters=%5B%22null%22%5D&from=example_string&to=example_string&limit=42&cursor=example_string", {
  method: "GET",
  headers: {
  "Content-Type": "application/json",
  "Authorization": "Bearer YOUR_API_TOKEN"
}
});

const data = await response.json();
console.log(data);

package main

import (
    "fmt"
    "net/http"
)

func main() {

    req, err := http.NewRequest("GET", "https://app.imploy.com.au/api/integrations/v1/clients/123/notes?search=example_string&filters=%5B%22null%22%5D&from=example_string&to=example_string&limit=42&cursor=example_string", nil)
    if err != nil {
        panic(err)
    }

    req.Header.Set("Content-Type", "application/json")
    req.Header.Set("Authorization", "Bearer YOUR_API_TOKEN")

    client := &http.Client{}
    resp, err := client.Do(req)
    if err != nil {
        panic(err)
    }
    defer resp.Body.Close()

    fmt.Println("Response Status:", resp.Status)
}

require 'net/http'
require 'json'

uri = URI('https://app.imploy.com.au/api/integrations/v1/clients/123/notes?search=example_string&filters=%5B%22null%22%5D&from=example_string&to=example_string&limit=42&cursor=example_string')
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = true

request = Net::HTTP::Get.new(uri)
request['Content-Type'] = 'application/json'
request['Authorization'] = 'Bearer YOUR_API_TOKEN'

response = http.request(request)
puts response.body

{
  "client": {
    "id": 12,
    "name": "Example Client"
  },
  "total": 1,
  "next_cursor": null,
  "notes": [
    "..."
  ]
}

GET

/clients/{client_id}/notes

GET

Base URLstring

Target server for requests. Edit to use your own host.

Bearer Token

Bearer Tokenstring

Required

An organisation access token that starts with imp_at_. Send it as Authorization: Bearer imp_at_XXXX.

The client id.

Words in the note, its title or type, or its author.

query

filtersarray

Notes tab filters, each with field, operator, value and an optional combinator (and or or). Fields: author, source, keyword, note_type, attachments, shift_cautions, date, employee, has_attachments and has_template. Operators: contains, does_not_contain, starts_with, ends_with, is, is_not, on_or_after, on_or_before, empty and not_empty. Send them as filters[0][field]=source style query parameters.