Get companies at an address as PDF
curl --request POST \
--url https://lens-api.tic.io/addresses/{id}/companies/pdf \
--header 'Content-Type: application/json-patch+json' \
--header 'x-api-key: <api-key>' \
--data '
{
"startRow": 123,
"endRow": 123,
"rowGroupCols": [
{
"id": "<string>",
"displayName": "<string>",
"field": "<string>"
}
],
"groupKeys": [
"<string>"
],
"filterModel": [
{
"columnName": "<string>",
"filterType": "<string>"
}
],
"sortModel": [
{
"colId": "<string>"
}
]
}
'import requests
url = "https://lens-api.tic.io/addresses/{id}/companies/pdf"
payload = {
"startRow": 123,
"endRow": 123,
"rowGroupCols": [
{
"id": "<string>",
"displayName": "<string>",
"field": "<string>"
}
],
"groupKeys": ["<string>"],
"filterModel": [
{
"columnName": "<string>",
"filterType": "<string>"
}
],
"sortModel": [{ "colId": "<string>" }]
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json-patch+json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json-patch+json'},
body: JSON.stringify({
startRow: 123,
endRow: 123,
rowGroupCols: [{id: '<string>', displayName: '<string>', field: '<string>'}],
groupKeys: ['<string>'],
filterModel: [{columnName: '<string>', filterType: '<string>'}],
sortModel: [{colId: '<string>'}]
})
};
fetch('https://lens-api.tic.io/addresses/{id}/companies/pdf', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://lens-api.tic.io/addresses/{id}/companies/pdf",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'startRow' => 123,
'endRow' => 123,
'rowGroupCols' => [
[
'id' => '<string>',
'displayName' => '<string>',
'field' => '<string>'
]
],
'groupKeys' => [
'<string>'
],
'filterModel' => [
[
'columnName' => '<string>',
'filterType' => '<string>'
]
],
'sortModel' => [
[
'colId' => '<string>'
]
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json-patch+json",
"x-api-key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://lens-api.tic.io/addresses/{id}/companies/pdf"
payload := strings.NewReader("{\n \"startRow\": 123,\n \"endRow\": 123,\n \"rowGroupCols\": [\n {\n \"id\": \"<string>\",\n \"displayName\": \"<string>\",\n \"field\": \"<string>\"\n }\n ],\n \"groupKeys\": [\n \"<string>\"\n ],\n \"filterModel\": [\n {\n \"columnName\": \"<string>\",\n \"filterType\": \"<string>\"\n }\n ],\n \"sortModel\": [\n {\n \"colId\": \"<string>\"\n }\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-api-key", "<api-key>")
req.Header.Add("Content-Type", "application/json-patch+json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://lens-api.tic.io/addresses/{id}/companies/pdf")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json-patch+json")
.body("{\n \"startRow\": 123,\n \"endRow\": 123,\n \"rowGroupCols\": [\n {\n \"id\": \"<string>\",\n \"displayName\": \"<string>\",\n \"field\": \"<string>\"\n }\n ],\n \"groupKeys\": [\n \"<string>\"\n ],\n \"filterModel\": [\n {\n \"columnName\": \"<string>\",\n \"filterType\": \"<string>\"\n }\n ],\n \"sortModel\": [\n {\n \"colId\": \"<string>\"\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://lens-api.tic.io/addresses/{id}/companies/pdf")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json-patch+json'
request.body = "{\n \"startRow\": 123,\n \"endRow\": 123,\n \"rowGroupCols\": [\n {\n \"id\": \"<string>\",\n \"displayName\": \"<string>\",\n \"field\": \"<string>\"\n }\n ],\n \"groupKeys\": [\n \"<string>\"\n ],\n \"filterModel\": [\n {\n \"columnName\": \"<string>\",\n \"filterType\": \"<string>\"\n }\n ],\n \"sortModel\": [\n {\n \"colId\": \"<string>\"\n }\n ]\n}"
response = http.request(request)
puts response.read_body"<string>"PDF reports
Get companies at an address as PDF
The companies registered at the address as a PDF report, with the filter and sort of the AG Grid request; at most 1 000 rows.
POST
/
addresses
/
{id}
/
companies
/
pdf
Get companies at an address as PDF
curl --request POST \
--url https://lens-api.tic.io/addresses/{id}/companies/pdf \
--header 'Content-Type: application/json-patch+json' \
--header 'x-api-key: <api-key>' \
--data '
{
"startRow": 123,
"endRow": 123,
"rowGroupCols": [
{
"id": "<string>",
"displayName": "<string>",
"field": "<string>"
}
],
"groupKeys": [
"<string>"
],
"filterModel": [
{
"columnName": "<string>",
"filterType": "<string>"
}
],
"sortModel": [
{
"colId": "<string>"
}
]
}
'import requests
url = "https://lens-api.tic.io/addresses/{id}/companies/pdf"
payload = {
"startRow": 123,
"endRow": 123,
"rowGroupCols": [
{
"id": "<string>",
"displayName": "<string>",
"field": "<string>"
}
],
"groupKeys": ["<string>"],
"filterModel": [
{
"columnName": "<string>",
"filterType": "<string>"
}
],
"sortModel": [{ "colId": "<string>" }]
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json-patch+json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json-patch+json'},
body: JSON.stringify({
startRow: 123,
endRow: 123,
rowGroupCols: [{id: '<string>', displayName: '<string>', field: '<string>'}],
groupKeys: ['<string>'],
filterModel: [{columnName: '<string>', filterType: '<string>'}],
sortModel: [{colId: '<string>'}]
})
};
fetch('https://lens-api.tic.io/addresses/{id}/companies/pdf', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://lens-api.tic.io/addresses/{id}/companies/pdf",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'startRow' => 123,
'endRow' => 123,
'rowGroupCols' => [
[
'id' => '<string>',
'displayName' => '<string>',
'field' => '<string>'
]
],
'groupKeys' => [
'<string>'
],
'filterModel' => [
[
'columnName' => '<string>',
'filterType' => '<string>'
]
],
'sortModel' => [
[
'colId' => '<string>'
]
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json-patch+json",
"x-api-key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://lens-api.tic.io/addresses/{id}/companies/pdf"
payload := strings.NewReader("{\n \"startRow\": 123,\n \"endRow\": 123,\n \"rowGroupCols\": [\n {\n \"id\": \"<string>\",\n \"displayName\": \"<string>\",\n \"field\": \"<string>\"\n }\n ],\n \"groupKeys\": [\n \"<string>\"\n ],\n \"filterModel\": [\n {\n \"columnName\": \"<string>\",\n \"filterType\": \"<string>\"\n }\n ],\n \"sortModel\": [\n {\n \"colId\": \"<string>\"\n }\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-api-key", "<api-key>")
req.Header.Add("Content-Type", "application/json-patch+json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://lens-api.tic.io/addresses/{id}/companies/pdf")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json-patch+json")
.body("{\n \"startRow\": 123,\n \"endRow\": 123,\n \"rowGroupCols\": [\n {\n \"id\": \"<string>\",\n \"displayName\": \"<string>\",\n \"field\": \"<string>\"\n }\n ],\n \"groupKeys\": [\n \"<string>\"\n ],\n \"filterModel\": [\n {\n \"columnName\": \"<string>\",\n \"filterType\": \"<string>\"\n }\n ],\n \"sortModel\": [\n {\n \"colId\": \"<string>\"\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://lens-api.tic.io/addresses/{id}/companies/pdf")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json-patch+json'
request.body = "{\n \"startRow\": 123,\n \"endRow\": 123,\n \"rowGroupCols\": [\n {\n \"id\": \"<string>\",\n \"displayName\": \"<string>\",\n \"field\": \"<string>\"\n }\n ],\n \"groupKeys\": [\n \"<string>\"\n ],\n \"filterModel\": [\n {\n \"columnName\": \"<string>\",\n \"filterType\": \"<string>\"\n }\n ],\n \"sortModel\": [\n {\n \"colId\": \"<string>\"\n }\n ]\n}"
response = http.request(request)
puts response.read_body"<string>"Max+ tier
The data of Companies as a PDF report, laid out the way the view shows it in TIC LENS.
Send the same
filterModel and sortModel as to the grid endpoint to get the rows the grid shows; startRow and endRow are ignored, and an empty body means no filter and the default order. The report holds the first 1,000 rows and says so when the result has more.
See PDF reports for the language, the file name and the row limit.Authorizations
Path Parameters
Internal address ID
Query Parameters
Report language, sv or en. Defaults to the caller's locale.
Body
application/json-patch+jsonapplication/jsontext/jsonapplication/*+json
Response
PDF report
The response is of type file.