POST
/
markets
/
{marketId}
/
companies
/
attributes

Path

marketId
string

The ID of the market which you want to retrieve countries of. This can be retrieved by searching for markets.

Body Request Object Example

This endpoint is typically called once with only the marketId without any filters first to know all the possible literal values to filter by. Then when the user selects the desired attributes, subsequent calls can be filtered by a relevant POST body JSON.

Using all the possible keys:

{
    "domains": ["ibm.com", "otter.ai"],
    "hqCountries": ["United States", "United Kingdom"],
    "operatesIn": [
        {
            "country": "France"
        },
        {
            "country": "Germany"
        }
    ]
    "naics": [334400, 541000],
    "diversityCertifications": [
        "Disabled Veteran Business Enterprise",
        "People With Disability"
    ]
}

Body

domains
string[]

If specified, return only attributes of companies matching the given domains.

hqCountries
string[]

If specified, return only attributes of companies with headquarters matching any of the given countries.

The special value of '(No Data)' is a valid input here, for any companies that do not have their HQ country registered.

operatesIn
array

If specified, return only companies which had recently operated in any of the given locations.

naics
integer[]

If specified, return only attributes of companies matching any of the given NAICS codes.

If a parent NAICS node is specified, all children nodes are automatically included.

diversityCertifications
string[]

If specified, return only attributes of companies matching any of the given diversity certifications.

The special value of '(No Certifications)' is a valid input here, for any companies that do not have any diversity certifications.

Use this endpoint without a diversityCertifications filter to check the valid values.

Response

meta
object

Metadata summarizing the data returned.

data
object

The attributes associated with the filtered companies.