Back to Collection Items
load ./chilkat.dll
# This example assumes the Chilkat API to have been previously unlocked.
# See Global Unlock Sample for sample code.
set http [new_CkHttp]
# Adds the "Authorization: Bearer <access_token>" header.
CkHttp_put_AuthToken $http "<access_token>"
CkHttp_SetRequestHeader $http "Accept" "application/json"
set sbResponseBody [new_CkStringBuilder]
set success [CkHttp_QuickGetSb $http "https://api-v2.fattureincloud.it/c/:company_id/emails" $sbResponseBody]
if {$success == 0} then {
puts [CkHttp_lastErrorText $http]
delete_CkHttp $http
delete_CkStringBuilder $sbResponseBody
exit
}
set jResp [new_CkJsonObject]
CkJsonObject_LoadSb $jResp $sbResponseBody
CkJsonObject_put_EmitCompact $jResp 0
puts "Response Body:"
puts [CkJsonObject_emit $jResp]
set respStatusCode [CkHttp_get_LastStatus $http]
puts "Response Status Code = $respStatusCode"
if {$respStatusCode >= 400} then {
puts "Response Header:"
puts [CkHttp_lastHeader $http]
puts "Failed."
delete_CkHttp $http
delete_CkStringBuilder $sbResponseBody
delete_CkJsonObject $jResp
exit
}
# Sample JSON response:
# (Sample code for parsing the JSON response is shown below)
# {
# "current_page": "<integer>",
# "first_page_url": "<uri>",
# "from": "<integer>",
# "last_page": "<integer>",
# "last_page_url": "<uri>",
# "next_page_url": "<uri>",
# "path": "<uri>",
# "per_page": "<integer>",
# "prev_page_url": "<uri>",
# "to": "<integer>",
# "total": "<integer>",
# "data": [
# {
# "id": "<integer>",
# "status": "pending",
# "sent_date": "<dateTime>",
# "errors_count": "<integer>",
# "error_log": "<string>",
# "from_email": "<string>",
# "from_name": "<string>",
# "to_email": "<string>",
# "to_name": "<string>",
# "subject": "<string>",
# "content": "<string>",
# "copy_to": "<string>",
# "recipient_status": "email_opened",
# "recipient_date": "<dateTime>",
# "kind": "<string>",
# "attachments": [
# {
# "filename": "<string>",
# "url": "<string>"
# },
# {
# "filename": "<string>",
# "url": "<string>"
# }
# ]
# },
# {
# "id": "<integer>",
# "status": "sending",
# "sent_date": "<dateTime>",
# "errors_count": "<integer>",
# "error_log": "<string>",
# "from_email": "<string>",
# "from_name": "<string>",
# "to_email": "<string>",
# "to_name": "<string>",
# "subject": "<string>",
# "content": "<string>",
# "copy_to": "<string>",
# "recipient_status": "document_opened",
# "recipient_date": "<dateTime>",
# "kind": "<string>",
# "attachments": [
# {
# "filename": "<string>",
# "url": "<string>"
# },
# {
# "filename": "<string>",
# "url": "<string>"
# }
# ]
# }
# ]
# }
# Sample code for parsing the JSON response...
# Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
set current_page [CkJsonObject_stringOf $jResp "current_page"]
set first_page_url [CkJsonObject_stringOf $jResp "first_page_url"]
set from [CkJsonObject_stringOf $jResp "from"]
set last_page [CkJsonObject_stringOf $jResp "last_page"]
set last_page_url [CkJsonObject_stringOf $jResp "last_page_url"]
set next_page_url [CkJsonObject_stringOf $jResp "next_page_url"]
set path [CkJsonObject_stringOf $jResp "path"]
set per_page [CkJsonObject_stringOf $jResp "per_page"]
set prev_page_url [CkJsonObject_stringOf $jResp "prev_page_url"]
set v_to [CkJsonObject_stringOf $jResp "to"]
set total [CkJsonObject_stringOf $jResp "total"]
set i 0
set count_i [CkJsonObject_SizeOfArray $jResp "data"]
while {$i < $count_i} {
CkJsonObject_put_I $jResp $i
set id [CkJsonObject_stringOf $jResp "data[i].id"]
set status [CkJsonObject_stringOf $jResp "data[i].status"]
set sent_date [CkJsonObject_stringOf $jResp "data[i].sent_date"]
set errors_count [CkJsonObject_stringOf $jResp "data[i].errors_count"]
set error_log [CkJsonObject_stringOf $jResp "data[i].error_log"]
set from_email [CkJsonObject_stringOf $jResp "data[i].from_email"]
set from_name [CkJsonObject_stringOf $jResp "data[i].from_name"]
set to_email [CkJsonObject_stringOf $jResp "data[i].to_email"]
set to_name [CkJsonObject_stringOf $jResp "data[i].to_name"]
set subject [CkJsonObject_stringOf $jResp "data[i].subject"]
set content [CkJsonObject_stringOf $jResp "data[i].content"]
set copy_to [CkJsonObject_stringOf $jResp "data[i].copy_to"]
set recipient_status [CkJsonObject_stringOf $jResp "data[i].recipient_status"]
set recipient_date [CkJsonObject_stringOf $jResp "data[i].recipient_date"]
set kind [CkJsonObject_stringOf $jResp "data[i].kind"]
set j 0
set count_j [CkJsonObject_SizeOfArray $jResp "data[i].attachments"]
while {$j < $count_j} {
CkJsonObject_put_J $jResp $j
set filename [CkJsonObject_stringOf $jResp "data[i].attachments[j].filename"]
set url [CkJsonObject_stringOf $jResp "data[i].attachments[j].url"]
set j [expr $j + 1]
}
set i [expr $i + 1]
}
delete_CkHttp $http
delete_CkStringBuilder $sbResponseBody
delete_CkJsonObject $jResp
Curl Command
curl -X GET
-H "Authorization: Bearer <access_token>"
-H "Accept: application/json"
https://api-v2.fattureincloud.it/c/:company_id/emails
Postman Collection Item JSON
{
"name": "List emails",
"request": {
"auth": {
"type": "oauth2",
"oauth2": [
{
"key": "scope",
"value": "entity.clients:r entity.clients:a entity.suppliers:r entity.suppliers:a products:r products:a issued_documents.invoices:r issued_documents.credit_notes:r issued_documents.receipts:r issued_documents.orders:r issued_documents.quotes:r issued_documents.proformas:r issued_documents.delivery_notes:r issued_documents.work_reports:r issued_documents.supplier_orders:r issued_documents.self_invoices:r issued_documents.invoices:a issued_documents.credit_notes:a issued_documents.receipts:a issued_documents.orders:a issued_documents.quotes:a issued_documents.proformas:a issued_documents.delivery_notes:a issued_documents.work_reports:a issued_documents.supplier_orders:a issued_documents.self_invoices:a received_documents:r received_documents:a stock:r stock:a receipts:r receipts:a taxes:r taxes:a archive:r archive:a cashbook:r cashbook:a settings:r settings:a situation:r",
"type": "string"
},
{
"key": "redirect_uri",
"value": "https://api-v2.fattureincloud.it/oauth/token",
"type": "string"
},
{
"key": "accessTokenUrl",
"value": "https://api-v2.fattureincloud.it/oauth/token",
"type": "string"
},
{
"key": "authUrl",
"value": "https://api-v2.fattureincloud.it/oauth/authorize",
"type": "string"
},
{
"key": "grant_type",
"value": "authorization_code",
"type": "string"
}
]
},
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/c/:company_id/emails",
"host": [
"{{baseUrl}}"
],
"path": [
"c",
":company_id",
"emails"
],
"variable": [
{
"key": "company_id",
"value": "<integer>"
}
]
},
"description": "List Emails."
},
"response": [
{
"name": "Example response",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"description": "Added as a part of security scheme: oauth2",
"key": "Authorization",
"value": "<token>"
}
],
"url": {
"raw": "{{baseUrl}}/c/:company_id/emails",
"host": [
"{{baseUrl}}"
],
"path": [
"c",
":company_id",
"emails"
],
"variable": [
{
"key": "company_id"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"current_page\": \"<integer>\",\n \"first_page_url\": \"<uri>\",\n \"from\": \"<integer>\",\n \"last_page\": \"<integer>\",\n \"last_page_url\": \"<uri>\",\n \"next_page_url\": \"<uri>\",\n \"path\": \"<uri>\",\n \"per_page\": \"<integer>\",\n \"prev_page_url\": \"<uri>\",\n \"to\": \"<integer>\",\n \"total\": \"<integer>\",\n \"data\": [\n {\n \"id\": \"<integer>\",\n \"status\": \"pending\",\n \"sent_date\": \"<dateTime>\",\n \"errors_count\": \"<integer>\",\n \"error_log\": \"<string>\",\n \"from_email\": \"<string>\",\n \"from_name\": \"<string>\",\n \"to_email\": \"<string>\",\n \"to_name\": \"<string>\",\n \"subject\": \"<string>\",\n \"content\": \"<string>\",\n \"copy_to\": \"<string>\",\n \"recipient_status\": \"email_opened\",\n \"recipient_date\": \"<dateTime>\",\n \"kind\": \"<string>\",\n \"attachments\": [\n {\n \"filename\": \"<string>\",\n \"url\": \"<string>\"\n },\n {\n \"filename\": \"<string>\",\n \"url\": \"<string>\"\n }\n ]\n },\n {\n \"id\": \"<integer>\",\n \"status\": \"sending\",\n \"sent_date\": \"<dateTime>\",\n \"errors_count\": \"<integer>\",\n \"error_log\": \"<string>\",\n \"from_email\": \"<string>\",\n \"from_name\": \"<string>\",\n \"to_email\": \"<string>\",\n \"to_name\": \"<string>\",\n \"subject\": \"<string>\",\n \"content\": \"<string>\",\n \"copy_to\": \"<string>\",\n \"recipient_status\": \"document_opened\",\n \"recipient_date\": \"<dateTime>\",\n \"kind\": \"<string>\",\n \"attachments\": [\n {\n \"filename\": \"<string>\",\n \"url\": \"<string>\"\n },\n {\n \"filename\": \"<string>\",\n \"url\": \"<string>\"\n }\n ]\n }\n ]\n}"
}
]
}
