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 | Stats |
|---|---|---|---|---|---|---|
| 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 | date | - | |||
| items[].birthPlace.macroregion Private field | macro region of the person birth place | "string" | - | |||
| items[].birthPlace.municipality Private field | municipality of the person birth place | "string" | - | |||
| items[].birthPlace.province Private field | province of the person birth place | "string" | - | |||
| items[].birthPlace.provinceCode Private field | province code of the person birth place | "string" | - | |||
| items[].birthPlace.region Private field | region of the person birth place | "string" | - | |||
| items[].birthPlace.state Private field | state of the person birth place. This field could change in future due to language depencencies | "string" | - | |||
| items[].birthPlace.stateCode Private field | state code of the person birth place | "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 | full name of the subject holding the position | "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 | - | |||
| items[].taxId Private field | the tax ID ("codice fiscale") of the person | "string" | - |
Example JSON fragment for package
{"count": 42, "items": [{"id": "foo", "cervedId": 42, "name": "foo", "givenName": "foo", "familyName": "foo", "gender": "foo", "taxId": "DOEJHN90A01H501H", "birthDate": "2015-12-24", "birthPlace": {"municipality": "Roma", "province": "Roma", "provinceCode": "RM", "region": "Lazio", "macroregion": "Centro", "state": "Italia", "stateCode": "it" },"cLevels": ["foo",...],"areas": ["foo",...],"roles": [{"name": "foo", "area": "foo", "since": "2015-12-24" },...],"emails": [{"address": "foo", "verified": false },...]},...]}