Get a note - Slant docs

GET

/

v1

/

contacts

/

{contact_id}

/

notes

/

{id}

Get a note

curl --request GET \
  --url https://api.slant.app/v1/contacts/{contact_id}/notes/{id} \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.slant.app/v1/contacts/{contact_id}/notes/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.slant.app/v1/contacts/{contact_id}/notes/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.slant.app/v1/contacts/{contact_id}/notes/{id}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.slant.app/v1/contacts/{contact_id}/notes/{id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

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

{
  "id": "abc123xyz",
  "content": "Meeting notes from client discussion",
  "pinned": false,
  "tag_ids": [
    "<string>"
  ],
  "references": [
    {
      "id": "<string>",
      "type": "Business",
      "label": "<string>"
    }
  ],
  "book_id": "book123xyz",
  "notable_type": "<string>",
  "notable_id": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "hidden": false,
  "household_id": "household123xyz",
  "created_by_id": "user123xyz"
}

Authorizations

Authorization

string

header

required

OAuth 2.0 Bearer Token from Clerk authentication

Path Parameters

id

string

required

The note ID

contact_id

string

required

The contact ID

Response

successful

id

string

required

The note ID

Example:

"abc123xyz"

content

string

required

The plaintext content of the note

Example:

"Meeting notes from client discussion"

pinned

boolean

required

Whether the note is pinned

Example:

false

tag_ids

string[]

required

The complete set of label IDs applied to the note

references

object[]

required

Records referenced by the note

Show child attributes

book_id

string

required

The book ID

Example:

"book123xyz"

notable_type

string

required

The type of record the note belongs to

notable_id

string

required

The ID of the record the note belongs to

created_at

string<date-time>

required

When the note was created

updated_at

string<date-time>

required

When the note was last updated

hidden

boolean

Whether the note is hidden

Example:

false

household_id

string | null

The household ID

Example:

"household123xyz"

created_by_id

string | null

The ID of the user who created the note

Example:

"user123xyz"

⌘I

Get a note

curl --request GET \
  --url https://api.slant.app/v1/contacts/{contact_id}/notes/{id} \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.slant.app/v1/contacts/{contact_id}/notes/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.slant.app/v1/contacts/{contact_id}/notes/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.slant.app/v1/contacts/{contact_id}/notes/{id}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.slant.app/v1/contacts/{contact_id}/notes/{id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

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

{
  "id": "abc123xyz",
  "content": "Meeting notes from client discussion",
  "pinned": false,
  "tag_ids": [
    "<string>"
  ],
  "references": [
    {
      "id": "<string>",
      "type": "Business",
      "label": "<string>"
    }
  ],
  "book_id": "book123xyz",
  "notable_type": "<string>",
  "notable_id": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "hidden": false,
  "household_id": "household123xyz",
  "created_by_id": "user123xyz"
}