Back to Collection Items
; This example assumes the Chilkat API to have been previously unlocked.
; See Global Unlock Sample for sample code.
$oHttp = ObjCreate("Chilkat.Http")
Local $bSuccess
; Adds the "Authorization: Bearer <access_token>" header.
$oHttp.AuthToken = "<access_token>"
$oHttp.SetRequestHeader "Accept","application/json"
$oSbResponseBody = ObjCreate("Chilkat.StringBuilder")
$bSuccess = $oHttp.QuickGetSb("https://api-v2.fattureincloud.it/c/:company_id/emails",$oSbResponseBody)
If ($bSuccess = False) Then
ConsoleWrite($oHttp.LastErrorText & @CRLF)
Exit
EndIf
$oJResp = ObjCreate("Chilkat.JsonObject")
$oJResp.LoadSb($oSbResponseBody)
$oJResp.EmitCompact = False
ConsoleWrite("Response Body:" & @CRLF)
ConsoleWrite($oJResp.Emit() & @CRLF)
Local $iRespStatusCode = $oHttp.LastStatus
ConsoleWrite("Response Status Code = " & $iRespStatusCode & @CRLF)
If ($iRespStatusCode >= 400) Then
ConsoleWrite("Response Header:" & @CRLF)
ConsoleWrite($oHttp.LastHeader & @CRLF)
ConsoleWrite("Failed." & @CRLF)
Exit
EndIf
; 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
Local $sId
Local $status
Local $sent_date
Local $sErrors_count
Local $sError_log
Local $sFrom_email
Local $sFrom_name
Local $sTo_email
Local $sTo_name
Local $subject
Local $sContent
Local $sCopy_to
Local $sRecipient_status
Local $sRecipient_date
Local $sKind
Local $iJ
Local $iCount_j
Local $sFilename
Local $sUrl
Local $sCurrent_page = $oJResp.StringOf("current_page")
Local $sFirst_page_url = $oJResp.StringOf("first_page_url")
Local $sFrom = $oJResp.StringOf("from")
Local $sLast_page = $oJResp.StringOf("last_page")
Local $sLast_page_url = $oJResp.StringOf("last_page_url")
Local $sNext_page_url = $oJResp.StringOf("next_page_url")
Local $sPath = $oJResp.StringOf("path")
Local $sPer_page = $oJResp.StringOf("per_page")
Local $sPrev_page_url = $oJResp.StringOf("prev_page_url")
Local $sV_to = $oJResp.StringOf("to")
Local $sTotal = $oJResp.StringOf("total")
Local $i = 0
Local $iCount_i = $oJResp.SizeOfArray("data")
While $i < $iCount_i
$oJResp.I = $i
$sId = $oJResp.StringOf("data[i].id")
$status = $oJResp.StringOf("data[i].status")
$sent_date = $oJResp.StringOf("data[i].sent_date")
$sErrors_count = $oJResp.StringOf("data[i].errors_count")
$sError_log = $oJResp.StringOf("data[i].error_log")
$sFrom_email = $oJResp.StringOf("data[i].from_email")
$sFrom_name = $oJResp.StringOf("data[i].from_name")
$sTo_email = $oJResp.StringOf("data[i].to_email")
$sTo_name = $oJResp.StringOf("data[i].to_name")
$subject = $oJResp.StringOf("data[i].subject")
$sContent = $oJResp.StringOf("data[i].content")
$sCopy_to = $oJResp.StringOf("data[i].copy_to")
$sRecipient_status = $oJResp.StringOf("data[i].recipient_status")
$sRecipient_date = $oJResp.StringOf("data[i].recipient_date")
$sKind = $oJResp.StringOf("data[i].kind")
$iJ = 0
$iCount_j = $oJResp.SizeOfArray("data[i].attachments")
While $iJ < $iCount_j
$oJResp.J = $iJ
$sFilename = $oJResp.StringOf("data[i].attachments[j].filename")
$sUrl = $oJResp.StringOf("data[i].attachments[j].url")
$iJ = $iJ + 1
Wend
$i = $i + 1
Wend
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}"
}
]
}
