Skip to content
LeadMCPDocs

Get the company schema

GET/companies/schema

Returns every public company column and every company filter key. Free.

FreeFree.

Returns every public company column and every company filter key. Free.

Response

The fields inside data.

columnsarray of SchemaColumnrequired

The public columns, in the default order.

Show child attributes

namestringrequired

The column name used in requests, files and rows.

typeenumrequired

The value type of the column. The list is frozen.

stringintegernumberbooleandatemontharrayobject

descriptionstringrequired

One sentence about what the column holds.

formatstringoptional

The value format, for example YYYY-MM or an ISO-2 slug.

nullablebooleanoptional

True when the column can be null. A null never matches a value key.

closed_listbooleanoptional

True when the column takes values from a closed slug list.

values_routestring or nulloptional

The route that lists the allowed values, or null.

filter_keysarray of SchemaFilterKeyrequired

The named filter keys a request may send.

Show child attributes

keystringrequired

The filter key name.

typeenumrequired

The shape the key takes. The list is frozen.

liststringbooleanintegermonth

descriptionstringrequired

One sentence about what the key matches.

columnstring or nulloptional

The column the key reads, or null for a derived key.

excludesstring or nulloptional

The exclude_* twin of this key, or null when it has none.

values_routestring or nulloptional

The route that lists the allowed values, or null.

aliasesarray of stringoptional

Input spellings that normalize to this key or its values.

notesarray of stringoptional

Stated limits of the filter language, for example that past employers are not in the data.

Failures

StatusMeaning
401The credential is missing, unknown or revoked.
429The key passed 300 requests a minute or 2 concurrent requests.