The view property controls which stored fields appear in each result’s data object.
Which view values can you send?
id_only is the default. Set view explicitly whenever your application needs record details, otherwise it receives identifiers rather than descriptive fields.
What does the summary view contain?
Company summary returns 14 fields: name, slogan, industry, headquarters_location, headquarters_country_code, offices_cities, company_size_from, company_size_to, employees_in_linkedin, linkedin_followers, website, domain, url and logo.
People summary returns 11 fields: name, current_title, current_company_name, current_company_industry, location, city, country_code, followers, connections, url and avatar.
A field the record has no value for is left out of data rather than returned as null, so two records from the same request can carry different keys.
What does the full view contain?
full returns every released field. Company full is the 14 summary fields plus about, specialties, organization_type, founded_year, headquarters_city, offices_country_codes, alumni_count, linkedin_follower_to_employee_ratio, funding_stage, funding_raised, investor_names, similar_company_ids, affiliated_company_ids, crunchbase_id, image and linkedin_id.
People full is the 11 summary fields plus first_name, about, recommendations_count, influencer, patent_count, current_tenure_months, experience_years, past_job_titles, past_company_names, past_company_ids, education_schools, education_details, certification_names, languages, current_company_id, current_company_specialties, current_company_country_code, current_company_size_from, current_company_size_to, current_company_funding_stage, current_company_funding_raised, similar_profile_ids, also_viewed_ids, linkedin_num_id and linkedin_person_id.
A fields list may name any of these. Fields the record has no value for are left out, so a full record usually carries fewer keys than the list.
How do you request a custom field list?
Use a custom field list when your application needs a specific set of fields, such as company founded_year, which is not included in the summary view:
A shorter field list keeps the response small and makes the contract between Business Search and your storage schema explicit. Add a field to the list when you start storing it, not before.
How should your code handle the returned data object?
Four rules keep a parser stable across records:
- Requested fields appear only when the source has a value for that record.
- Handle absent or null values without failing the entire record.
- An unknown or unreleased field name is rejected with HTTP 400
view: unknown field(s): not_a_released_field, and an unknown view name with view: unknown view profile "bogus_view". Validate a new field name once rather than on every request.
- Keep the
bright_id envelope field separate from entity fields in data. bright_id identifies the record and is not a property of the company or person.
A field you select for output does not become a search condition. Requesting founded_year in view does not exclude companies that have no founding year on record.
