Atoka API User Reference

Companies package "People"

This package contains the list of positions that people or companies have in this company. Here you can find at most the first 10 positions in this companies. For details about all the people having a position in a company you should use the People Search API combined with the companies fiter

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
count

number of people for which we know the position in the company

int -
items[]

list of positions that people or companies have in this company

- -
items[].areas[] THIS FEATURE IS NOT IMPLEMENTED, YET. If you need it, just get in touch with us at sales@atoka.io "string" -
items[].birthDate

birth date of the subject holding the position

"string" -
items[].cLevels[] "string" -
items[].cervedId Private field

Cerved ID of the subject holding the position

int -
items[].emails[].address

e-mail address

"string" -
items[].emails[].verified

the email address is confirmed to exist and receive messages

true | false -
items[].familyName

family name of the subject holding the position

"string" -
items[].gender

gender of the subject holding the position

"string" -
items[].givenName

given name of the subject holding the position

"string" -
items[].id

Atoka ID of the subject holding the position

"string" -
items[].name

name of the position the person holds in this company

"string" -
items[].roles[].area THIS FEATURE IS NOT IMPLEMENTED, YET. If you need it, just get in touch with us at sales@atoka.io

area of the position

"string" -
items[].roles[].name

name of the position

"string" -
items[].roles[].since

starting date

date -
Example JSON fragment for package
{
"count": 42,
"items": [
{
"id": "foo",
"cervedId": 42,
"name": "foo",
"givenName": "foo",
"familyName": "foo",
"gender": "foo",
"birthDate": "foo",
"cLevels": [
"foo",
...
],
"areas": [
"foo",
...
],
"roles": [
{
"name": "foo",
"area": "foo",
"since": "2015-12-24"
},
...
],
"emails": [
{
"address": "foo",
"verified": false
},
...
]
},
...
]
}