Back to Collection Items
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
loHttp = createobject("CkHttp")
// Adds the "Authorization: Bearer <access_token>" header.
loHttp.AuthToken = "<access_token>"
loHttp.SetRequestHeader("Accept","application/json")
loSbResponseBody = createobject("CkStringBuilder")
llSuccess = loHttp.QuickGetSb("https://api-v2.fattureincloud.it/c/:company_id/emails",loSbResponseBody)
if (llSuccess = .F.) then
? loHttp.LastErrorText
release loHttp
release loSbResponseBody
return
endif
loJResp = createobject("CkJsonObject")
loJResp.LoadSb(loSbResponseBody)
loJResp.EmitCompact = .F.
? "Response Body:"
? loJResp.Emit()
lnRespStatusCode = loHttp.LastStatus
? "Response Status Code = " + str(lnRespStatusCode)
if (lnRespStatusCode >= 400) then
? "Response Header:"
? loHttp.LastHeader
? "Failed."
release loHttp
release loSbResponseBody
release loJResp
return
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
lcCurrent_page = loJResp.StringOf("current_page")
lcFirst_page_url = loJResp.StringOf("first_page_url")
lcFrom = loJResp.StringOf("from")
lcLast_page = loJResp.StringOf("last_page")
lcLast_page_url = loJResp.StringOf("last_page_url")
lcNext_page_url = loJResp.StringOf("next_page_url")
lcPath = loJResp.StringOf("path")
lcPer_page = loJResp.StringOf("per_page")
lcPrev_page_url = loJResp.StringOf("prev_page_url")
lcV_to = loJResp.StringOf("to")
lcTotal = loJResp.StringOf("total")
i = 0
lnCount_i = loJResp.SizeOfArray("data")
do while i < lnCount_i
loJResp.I = i
lcId = loJResp.StringOf("data[i].id")
lcStatus = loJResp.StringOf("data[i].status")
lcSent_date = loJResp.StringOf("data[i].sent_date")
lcErrors_count = loJResp.StringOf("data[i].errors_count")
lcError_log = loJResp.StringOf("data[i].error_log")
lcFrom_email = loJResp.StringOf("data[i].from_email")
lcFrom_name = loJResp.StringOf("data[i].from_name")
lcTo_email = loJResp.StringOf("data[i].to_email")
lcTo_name = loJResp.StringOf("data[i].to_name")
lcSubject = loJResp.StringOf("data[i].subject")
lcContent = loJResp.StringOf("data[i].content")
lcCopy_to = loJResp.StringOf("data[i].copy_to")
lcRecipient_status = loJResp.StringOf("data[i].recipient_status")
lcRecipient_date = loJResp.StringOf("data[i].recipient_date")
lcKind = loJResp.StringOf("data[i].kind")
j = 0
lnCount_j = loJResp.SizeOfArray("data[i].attachments")
do while j < lnCount_j
loJResp.J = j
lcFilename = loJResp.StringOf("data[i].attachments[j].filename")
lcUrl = loJResp.StringOf("data[i].attachments[j].url")
j = j + 1
enddo
i = i + 1
enddo
release loHttp
release loSbResponseBody
release loJResp
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}"
}
]
}
