Back to Collection Items
' This example assumes the Chilkat API to have been previously unlocked.
' See Global Unlock Sample for sample code.
Dim http As New Chilkat.Http
Dim success As Boolean
' Adds the "Authorization: Bearer <access_token>" header.
http.AuthToken = "<access_token>"
http.SetRequestHeader("Accept","application/json")
Dim sbResponseBody As New Chilkat.StringBuilder
success = http.QuickGetSb("https://api-v2.fattureincloud.it/c/:company_id/emails",sbResponseBody)
If (success = False) Then
Debug.WriteLine(http.LastErrorText)
Exit Sub
End If
Dim jResp As New Chilkat.JsonObject
jResp.LoadSb(sbResponseBody)
jResp.EmitCompact = False
Debug.WriteLine("Response Body:")
Debug.WriteLine(jResp.Emit())
Dim respStatusCode As Integer = http.LastStatus
Debug.WriteLine("Response Status Code = " & respStatusCode)
If (respStatusCode >= 400) Then
Debug.WriteLine("Response Header:")
Debug.WriteLine(http.LastHeader)
Debug.WriteLine("Failed.")
Exit Sub
End If
' 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
Dim id As String
Dim status As String
Dim sent_date As String
Dim errors_count As String
Dim error_log As String
Dim from_email As String
Dim from_name As String
Dim to_email As String
Dim to_name As String
Dim subject As String
Dim content As String
Dim copy_to As String
Dim recipient_status As String
Dim recipient_date As String
Dim kind As String
Dim j As Integer
Dim count_j As Integer
Dim filename As String
Dim url As String
Dim current_page As String = jResp.StringOf("current_page")
Dim first_page_url As String = jResp.StringOf("first_page_url")
Dim from As String = jResp.StringOf("from")
Dim last_page As String = jResp.StringOf("last_page")
Dim last_page_url As String = jResp.StringOf("last_page_url")
Dim next_page_url As String = jResp.StringOf("next_page_url")
Dim path As String = jResp.StringOf("path")
Dim per_page As String = jResp.StringOf("per_page")
Dim prev_page_url As String = jResp.StringOf("prev_page_url")
Dim v_to As String = jResp.StringOf("to")
Dim total As String = jResp.StringOf("total")
Dim i As Integer = 0
Dim count_i As Integer = jResp.SizeOfArray("data")
While i < count_i
jResp.I = i
id = jResp.StringOf("data[i].id")
status = jResp.StringOf("data[i].status")
sent_date = jResp.StringOf("data[i].sent_date")
errors_count = jResp.StringOf("data[i].errors_count")
error_log = jResp.StringOf("data[i].error_log")
from_email = jResp.StringOf("data[i].from_email")
from_name = jResp.StringOf("data[i].from_name")
to_email = jResp.StringOf("data[i].to_email")
to_name = jResp.StringOf("data[i].to_name")
subject = jResp.StringOf("data[i].subject")
content = jResp.StringOf("data[i].content")
copy_to = jResp.StringOf("data[i].copy_to")
recipient_status = jResp.StringOf("data[i].recipient_status")
recipient_date = jResp.StringOf("data[i].recipient_date")
kind = jResp.StringOf("data[i].kind")
j = 0
count_j = jResp.SizeOfArray("data[i].attachments")
While j < count_j
jResp.J = j
filename = jResp.StringOf("data[i].attachments[j].filename")
url = jResp.StringOf("data[i].attachments[j].url")
j = j + 1
End While
i = i + 1
End While
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}"
}
]
}
