Atoka API User Reference

Companies Root Fields

These fields do not belong to a specific package, but are always returned for each company regardless the value of param packages

API tokens are configured to access only the packages each user needs; this means you might not have access to the content of this package. Ask your sales contact!

Available fields
Description
Data
Used by filters
Facet
Match
active

is the company active?

- active
cervedId Private field

Cerved ID (if present) of company

int -
country "it", "uk", "ru", "no" -
fullAddress

Full address of the company

"string" -
id

Unique ID that you can use throughout the API endpoints to reference to a specific company

"string" -
ids[] Private field

All IDs that you can use throughout the API endpoints to reference to a specific company

- -
lists[] Private field

companies lists in which the item in contained

- -
lists[].extraData Private field {"foo": "bar"} -
lists[].id Private field "string" -
lists[].listLength Private field int -
lists[].name Private field "string" -
lists[].owner.application Private field "string" -
lists[].owner.id Private field "string" -
lists[].owner.name Private field "string" -
lists[].permissions.manage Private field true | false -
lists[].permissions.read Private field true | false -
lists[].permissions.write Private field true | false -
lists[].type Private field "string" -
name

Cleaned name of the company

"string" -
Example JSON fragment for package
{
"id": "6da785b3adf219770c9e",
"ids": [
"foo",
...
],
"active": false,
"cervedId": 1015245,
"country": "it",
"fullAddress": "Via Garibaldi, 1, 01234, Roma (RM)",
"name": "ACME S.p.A.",
"lists": [
{
"id": "foo",
"name": "foo",
"extraData": {"foo": "bar"},
"listLength": 42,
"type": "foo",
"owner": {
"application": "foo",
"id": "foo",
"name": "foo"
},
"permissions": {
"read": false,
"write": false,
"manage": false
}
},
...
]
}