List all snippets - Fernand API Documentation

List all snippets

curl --request GET \
  --url https://api.getfernand.com/snippets \
  --header 'X-API-Key: <api-key>'

const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};

fetch('https://api.getfernand.com/snippets', 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.getfernand.com/snippets",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "X-API-Key: <api-key>"
  ],
]);

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

curl_close($curl);

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

require 'uri'
require 'net/http'

url = URI("https://api.getfernand.com/snippets")

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

request = Net::HTTP::Get.new(url)
request["X-API-Key"] = '<api-key>'

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

package main

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

func main() {

	url := "https://api.getfernand.com/snippets"

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

	req.Header.Add("X-API-Key", "<api-key>")

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

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

	fmt.Println(string(body))

}

using RestSharp;


var options = new RestClientOptions("https://api.getfernand.com/snippets");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddHeader("X-API-Key", "<api-key>");
var response = await client.GetAsync(request);

Console.WriteLine("{0}", response.Content);

[
  {
    "id": 42,
    "title": "Welcome Message",
    "created": "2024-01-15T10:30:00Z",
    "applied_count": 15,
    "categories": [
      1,
      3
    ],
    "actions": [
      {
        "id": 1,
        "name": "status",
        "data": {
          "status": "closed"
        },
        "sort": 0
      }
    ],
    "shortcut": "welcome",
    "last_applied_at": "2023-11-07T05:31:56Z"
  }
]

GET

/

snippets

List all snippets

curl --request GET \
  --url https://api.getfernand.com/snippets \
  --header 'X-API-Key: <api-key>'

const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};

fetch('https://api.getfernand.com/snippets', 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.getfernand.com/snippets",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "X-API-Key: <api-key>"
  ],
]);

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

curl_close($curl);

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

require 'uri'
require 'net/http'

url = URI("https://api.getfernand.com/snippets")

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

request = Net::HTTP::Get.new(url)
request["X-API-Key"] = '<api-key>'

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

package main

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

func main() {

	url := "https://api.getfernand.com/snippets"

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

	req.Header.Add("X-API-Key", "<api-key>")

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

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

	fmt.Println(string(body))

}

using RestSharp;


var options = new RestClientOptions("https://api.getfernand.com/snippets");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddHeader("X-API-Key", "<api-key>");
var response = await client.GetAsync(request);

Console.WriteLine("{0}", response.Content);

[
  {
    "id": 42,
    "title": "Welcome Message",
    "created": "2024-01-15T10:30:00Z",
    "applied_count": 15,
    "categories": [
      1,
      3
    ],
    "actions": [
      {
        "id": 1,
        "name": "status",
        "data": {
          "status": "closed"
        },
        "sort": 0
      }
    ],
    "shortcut": "welcome",
    "last_applied_at": "2023-11-07T05:31:56Z"
  }
]

Retrieves all snippets belonging to the authenticated user’s organization.

Authorizations

X-API-Key

string

header

required

Authenticate your account by including your secret key in API requests. You can manage your API keys in the Dashboard.

Authentication to the API is performed by using the HTTP Header X-API-Key.

Response

200 - application/json

Snippets retrieved successfully.

id

integer<int32>

required

Unique identifier for the snippet

Example:

42

title

string

required

Title of the snippet

Maximum string length: 250

Example:

"Welcome Message"

created

string<date-time>

required

Timestamp when the snippet was created (UTC)

Example:

"2024-01-15T10:30:00Z"

applied_count

integer<int32>

required

Number of times this snippet has been applied

Example:

15

categories

integer[]

required

Array of category IDs this snippet belongs to (0 represents root category)

Example:

[1, 3]

actions

object[]

required

Array of actions to be applied when the snippet is used

Show child attributes

Example:

[
  {
    "id": 1,
    "name": "status",
    "data": { "status": "closed" },
    "sort": 0
  }
]

shortcut

string | null

Optional keyboard shortcut to quickly insert the snippet (lowercase, numbers, and dashes only)

Maximum string length: 40

Pattern: ^[a-z0-9-]*$

Example:

"welcome"

last_applied_at

string<date-time> | null

Timestamp when the snippet was last applied to a conversation (UTC)