NAV
shell ruby python csharp php

Letter

The Letter object

The Letter object looks like this in JSON:

{
    "object": "letter",
    "id": 1,
    "sender_id": 157,
    "content": "Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Eget felis eget nunc lobortis mattis aliquam faucibus purus in. Ut porttitor leo a diam sollicitudin tempor id eu nisl. Congue quisque egestas diam in arcu. Cursus vitae congue mauris rhoncus aenean. Nisi est sit amet facilisis magna. Duis convallis convallis tellus id interdum. Tellus molestie nunc non blandit massa enim nec dui. At quis risus sed vulputate odio ut enim blandit.\r\n\r\nSincerely,\r\n\r\nLorem Ipsum, ESQ",
    "print_on": "2024-02-28",
    "num_recipients": 1,
    "num_copies": 1,
    "layout_id": 1,
    "template_id": 1,
    "mailing_list_id": null,
    "communication_plan_id": 1,
    "printed_at": null,
    "printed_by_id": null,
    "added_at": "2024-02-23T20:17:06+00:00",
    "added_by_id": 157,
    "sandbox": true
}
Attribute Required Data Type
id Yes int
sender_id Yes int
content No text
print_on No date
num_recipients Yes int
num_copies Yes int
layout_id Yes int
template_id No int
mailing_list_id No int
communication_plan_id No int
printed_at No datetime
printed_by_id No int
added_at No datetime
added_by_id No int
sandbox No bool

show

Example code to call this method:

curl "https://yourschool.populiweb.com/api2/letters/(letter)" \
-H "Content-Type: application/json" \ 
-H "Authorization: Bearer YOUR_POPULI_API_KEY" \ 
-X GET
require 'httparty'
response = HTTParty.get(
 'https://yourschool.populiweb.com/api2/letters/(letter)',
 headers: {
  'Authorization' => 'Bearer YOUR_POPULI_API_KEY'
 },
)
puts response.body
import requests
response = requests.get(
 'https://yourschool.populiweb.com/api2/letters/(letter)',
 headers={
  'Authorization': 'Bearer YOUR_POPULI_API_KEY'
 },
)
print(response.json())
using Newtonsoft.Json;
using RestSharp;
var client = new RestClient();
var request = new RestRequest(new Uri("https://yourschool.populiweb.com/api2/letters/(letter)"), Method.Get);
request.AddHeader("Authorization", "Bearer YOUR_POPULI_API_KEY");
var response = client.Execute(request);
var response_object = JsonConvert.DeserializeObject(response.Content);
Console.Write(response_object);
$curl = curl_init();
curl_setopt($curl, CURLOPT_URL, 'https://yourschool.populiweb.com/api2/letters/(letter)');
curl_setopt($curl, CURLOPT_HTTPHEADER, ['Authorization: Bearer YOUR_POPULI_API_KEY']);
curl_setopt($curl, CURLOPT_RETURNTRANSFER, 1);
curl_setopt($curl, CURLOPT_CUSTOMREQUEST, 'GET');
$response = curl_exec($curl);
$response_decoded = json_decode($response);
var_dump($response_decoded);

Example response:

{
    "object": "letter",
    "id": 1,
    "sender_id": 157,
    "content": "Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Eget felis eget nunc lobortis mattis aliquam faucibus purus in. Ut porttitor leo a diam sollicitudin tempor id eu nisl. Congue quisque egestas diam in arcu. Cursus vitae congue mauris rhoncus aenean. Nisi est sit amet facilisis magna. Duis convallis convallis tellus id interdum. Tellus molestie nunc non blandit massa enim nec dui. At quis risus sed vulputate odio ut enim blandit.\r\n\r\nSincerely,\r\n\r\nLorem Ipsum, ESQ",
    "print_on": "2024-02-28",
    "num_recipients": 1,
    "num_copies": 1,
    "layout_id": 1,
    "template_id": 1,
    "mailing_list_id": null,
    "communication_plan_id": 1,
    "printed_at": null,
    "printed_by_id": null,
    "added_at": "2024-02-23T20:17:06+00:00",
    "added_by_id": 157,
    "sandbox": true
}

Retrieves a specific Letter object.

HTTP Request

GET /letters/(letter)

Parameters

No additional parameters are needed beyond the ID of the object being requested that appears in the URL.

Expandable Properties

Permissions

One of the following roles is required to call this method: