openapi: 3.1.0 info: title: RocketReach Account People Data API API version: 1.0.0 description: Retrieve and manage RocketReach API account details, lookup quotas, plan usage, billing email, and webhook configuration. contact: name: RocketReach Support email: api@rocketreach.co license: name: Proprietary termsOfService: https://rocketreach.co/legal/terms-of-use servers: - url: https://api.rocketreach.co/api/v2 description: RocketReach v2 API - url: https://api.rocketreach.co/v1/api description: RocketReach v1 API security: - RocketReachAPIKey: [] tags: - name: People Data API paths: /person/lookup: get: operationId: create_person_lookup description: Person Enrichment API summary: People Lookup API parameters: - in: query name: current_employer schema: type: string minLength: 1 description: 'Current employer of the desired profile. Must specify along with `name`. - Example: `RocketReach`' - in: query name: email schema: type: string format: email minLength: 1 description: 'An email address for the desired profile. - Example: `jamie@rocketreach.co`' - in: query name: id schema: type: integer description: 'RocketReach internal unique profile ID. - Example: `123456`' - in: query name: linkedin_ext_url schema: type: string pattern: '' minLength: 1 description: linkedin_ext_url deprecated, please use `linkedin_url` instead deprecated: true - in: query name: linkedin_url schema: type: string pattern: '' minLength: 1 description: 'LinkedIn URL of the desired profile. - Example: `www.linkedin.com/in/jamesgullbrand`' - in: query name: lookup_type schema: enum: - standard - premium - premium (feeds disabled) - bulk - phone - enrich - '' - null type: - string - 'null' description: 'Lookup type for the request * `standard` - standard * `premium` - premium * `premium (feeds disabled)` - premium (feeds disabled) * `bulk` - bulk * `phone` - phone * `enrich` - enrich' - in: query name: name schema: type: string minLength: 1 description: 'Name of the desired profile. Must specify along with `current_employer`. - Example: `Jamie Gullbrand`' - in: query name: npi_number schema: type: integer description: 'An NPI number for the desired profile (US healthcare professional). - Example: `1234567890`' - in: query name: return_cached_emails schema: type: boolean default: true description: 'Controls whether cached emails are included in the initial response when `lookup status = progress`. When set to `false`, all email fields will be null until the lookup is complete and all emails are fully verified. Use /checkStatus or Webhooks to retrieve the completed response with fully verified emails (`status = complete`). Defaults to `true`. NOTE: Default will change to false on September 1st, 2026. No cached emails will be returned in the initial response. Use /checkStatus or webhooks to retrieve fully verified emails.' - in: query name: title schema: type: string minLength: 1 description: 'Job title of the desired profile. - Example: `Product Manager`' - in: query name: webhook_id schema: type: integer description: Your webhook's unique ID number. Find it in your API Usage & Settings page. tags: - People Data API security: - RocketReachAPIKey: [] responses: '200': headers: RR-Request-ID: schema: type: string format: uuid description: Lookup unique identifier, will also be sent in the header of webhook. content: application/json: schema: $ref: '#/components/schemas/ProfileAPICompiledCompany' description: Success. Returns the profile data for the person lookup. '400': headers: RR-Request-ID: schema: type: string format: uuid description: Lookup unique identifier, will also be sent in the header of webhook. description: Bad Request. The request is malformed or missing required parameters. '401': headers: RR-Request-ID: schema: type: string format: uuid description: Lookup unique identifier, will also be sent in the header of webhook. description: Unauthorized. API Key is missing or invalid. '403': headers: RR-Request-ID: schema: type: string format: uuid description: Lookup unique identifier, will also be sent in the header of webhook. description: Forbidden. API Key lacks permission to perform this action. '404': headers: RR-Request-ID: schema: type: string format: uuid description: Lookup unique identifier, will also be sent in the header of webhook. description: Not Found. The requested resource (e.g., profile) does not exist. '429': headers: RR-Request-ID: schema: type: string format: uuid description: Lookup unique identifier, will also be sent in the header of webhook. description: Too Many Requests. API request limit reached -- slow down requests. '500': headers: RR-Request-ID: schema: type: string format: uuid description: Lookup unique identifier, will also be sent in the header of webhook. description: Internal Server Error. Unexpected error on RocketReach servers. Try again later. /person/checkStatus: get: operationId: check_person_lookup_status description: Check Person Lookup Status summary: People Lookup Status API parameters: - in: query name: ids schema: type: array items: type: integer description: List of Profile IDs tags: - People Data API security: - RocketReachAPIKey: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/ProfileAPICompiledCompany' description: Success. Returns the status and profile data of the requested profiles. '400': description: Bad Request. The request is malformed or missing required parameters. '401': description: Unauthorized. API Key is missing or invalid. '403': description: Forbidden. API Key lacks permission to perform this action. '404': description: Not Found. The requested resource (e.g., profile) does not exist. '429': description: Too Many Requests. API request limit reached -- slow down requests. '500': description: Internal Server Error. Unexpected error on RocketReach servers. Try again later. /bulkLookup: post: operationId: create_person_bulk_lookup description: Bulk People Lookup by Criteria summary: Bulk People Lookup API tags: - People Data API requestBody: content: application/json: schema: $ref: '#/components/schemas/APIBulkLookupQuery' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/APIBulkLookupQuery' multipart/form-data: schema: $ref: '#/components/schemas/APIBulkLookupQuery' required: true security: - RocketReachAPIKey: [] responses: '200': headers: RR-Request-ID: schema: type: string format: uuid description: Lookup unique identifier, will also be sent in the header of webhook. description: Success. Bulk lookup request accepted '400': headers: RR-Request-ID: schema: type: string format: uuid description: Lookup unique identifier, will also be sent in the header of webhook. description: Bad Request. The request is malformed or missing required parameters. '401': headers: RR-Request-ID: schema: type: string format: uuid description: Lookup unique identifier, will also be sent in the header of webhook. description: Unauthorized. API Key is missing or invalid. '403': headers: RR-Request-ID: schema: type: string format: uuid description: Lookup unique identifier, will also be sent in the header of webhook. description: Forbidden. API Key lacks permission to perform this action. '404': headers: RR-Request-ID: schema: type: string format: uuid description: Lookup unique identifier, will also be sent in the header of webhook. description: Not Found. The requested resource (e.g., profile) does not exist. '429': headers: RR-Request-ID: schema: type: string format: uuid description: Lookup unique identifier, will also be sent in the header of webhook. description: Too Many Requests. API request limit reached -- slow down requests. '500': headers: RR-Request-ID: schema: type: string format: uuid description: Lookup unique identifier, will also be sent in the header of webhook. description: Internal Server Error. Unexpected error on RocketReach servers. Try again later. /profile-company/lookup: get: operationId: create_person_and_company_lookup description: Person and Company Lookup summary: People and Company Lookup API parameters: - in: query name: current_employer schema: type: string minLength: 1 description: 'Current employer of the desired profile. Must specify along with `name`. - Example: `RocketReach`' - in: query name: email schema: type: string format: email minLength: 1 description: 'An email address for the desired profile. - Example: `jamie@rocketreach.co`' - in: query name: id schema: type: integer description: 'RocketReach internal unique profile ID. - Example: `123456`' - in: query name: linkedin_ext_url schema: type: string pattern: '' minLength: 1 description: linkedin_ext_url deprecated, please use `linkedin_url` instead deprecated: true - in: query name: linkedin_url schema: type: string pattern: '' minLength: 1 description: 'LinkedIn URL of the desired profile. - Example: `www.linkedin.com/in/jamesgullbrand`' - in: query name: lookup_type schema: enum: - standard - premium - premium (feeds disabled) - bulk - phone - enrich - '' - null type: - string - 'null' description: 'Lookup type for the request * `standard` - standard * `premium` - premium * `premium (feeds disabled)` - premium (feeds disabled) * `bulk` - bulk * `phone` - phone * `enrich` - enrich' - in: query name: name schema: type: string minLength: 1 description: 'Name of the desired profile. Must specify along with `current_employer`. - Example: `Jamie Gullbrand`' - in: query name: npi_number schema: type: integer description: 'An NPI number for the desired profile (US healthcare professional). - Example: `1234567890`' - in: query name: return_cached_emails schema: type: boolean default: true description: 'Controls whether cached emails are included in the initial response when `lookup status = progress`. When set to `false`, all email fields will be null until the lookup is complete and all emails are fully verified. Use /checkStatus or Webhooks to retrieve the completed response with fully verified emails (`status = complete`). Defaults to `true`. NOTE: Default will change to false on September 1st, 2026. No cached emails will be returned in the initial response. Use /checkStatus or webhooks to retrieve fully verified emails.' - in: query name: title schema: type: string minLength: 1 description: 'Job title of the desired profile. - Example: `Product Manager`' - in: query name: webhook_id schema: type: integer description: Your webhook's unique ID number. Find it in your API Usage & Settings page. tags: - People Data API security: - RocketReachAPIKey: [] responses: '200': headers: RR-Request-ID: schema: type: string format: uuid description: Lookup unique identifier, will also be sent in the header of webhook. content: application/json: schema: $ref: '#/components/schemas/ProfileAPISerializerWithCompiledCompany' description: Success. Returns the profile data and company data for the person / company lookup. '400': headers: RR-Request-ID: schema: type: string format: uuid description: Lookup unique identifier, will also be sent in the header of webhook. description: Bad Request. The request is malformed or missing required parameters. '401': headers: RR-Request-ID: schema: type: string format: uuid description: Lookup unique identifier, will also be sent in the header of webhook. description: Unauthorized. API Key is missing or invalid. '403': headers: RR-Request-ID: schema: type: string format: uuid description: Lookup unique identifier, will also be sent in the header of webhook. description: Forbidden. API Key lacks permission to perform this action. '404': headers: RR-Request-ID: schema: type: string format: uuid description: Lookup unique identifier, will also be sent in the header of webhook. description: Not Found. The requested resource (e.g., profile) does not exist. '429': headers: RR-Request-ID: schema: type: string format: uuid description: Lookup unique identifier, will also be sent in the header of webhook. description: Too Many Requests. API request limit reached -- slow down requests. '500': headers: RR-Request-ID: schema: type: string format: uuid description: Lookup unique identifier, will also be sent in the header of webhook. description: Internal Server Error. Unexpected error on RocketReach servers. Try again later. /universal/person/lookup: get: operationId: create_universal_person_lookup description: Person Enrichment API summary: ⭐ Universal People Lookup API parameters: - in: query name: current_employer schema: type: string minLength: 1 description: 'Current employer of the desired profile. Must specify along with `name`. - Example: `RocketReach`' - in: query name: email schema: type: string format: email minLength: 1 description: 'An email address for the desired profile. - Example: `jamie@rocketreach.co`' - in: query name: id schema: type: integer description: 'RocketReach internal unique profile ID. - Example: `123456`' - in: query name: linkedin_ext_url schema: type: string pattern: '' minLength: 1 description: linkedin_ext_url deprecated, please use `linkedin_url` instead deprecated: true - in: query name: linkedin_url schema: type: string pattern: '' minLength: 1 description: 'LinkedIn URL of the desired profile. - Example: `www.linkedin.com/in/jamesgullbrand`' - in: query name: metadata schema: type: - object - 'null' additionalProperties: {} description: User metadata about the profile, such as external ids, tags, notes, etc. - in: query name: name schema: type: string minLength: 1 description: 'Name of the desired profile. Must specify along with `current_employer`. - Example: `Jamie Gullbrand`' - in: query name: npi_number schema: type: integer description: 'An NPI number for the desired profile (US healthcare professional). - Example: `1234567890`' - in: query name: return_cached_emails schema: type: boolean default: true description: 'Controls whether cached emails are included in the initial response when `lookup status = progress`. When set to `false`, all email fields will be null until the lookup is complete and all emails are fully verified. Use /checkStatus or Webhooks to retrieve the completed response with fully verified emails (`status = complete`). Defaults to `true`. NOTE: Default will change to false on September 1st, 2026. No cached emails will be returned in the initial response. Use /checkStatus or webhooks to retrieve fully verified emails.' - in: query name: reveal_detailed_person_enrichment schema: type: boolean default: false description: Whether to reveal the detailed person enrichment data for the desired profile - in: query name: reveal_healthcare_enrichment schema: type: boolean default: false description: Whether to reveal the healthcare enrichment data for the desired profile - in: query name: reveal_personal_email schema: type: boolean default: false description: Whether to reveal the personal email enrichment data for the desired profile - in: query name: reveal_phone schema: type: boolean default: false description: Whether to reveal the phone enrichment data for the desired profile - in: query name: reveal_professional_email schema: type: boolean default: false description: Whether to reveal the professional email enrichment data for the desired profile - in: query name: title schema: type: string minLength: 1 description: 'Job title of the desired profile. - Example: `Product Manager`' - in: query name: webhook_id schema: type: integer description: Your webhook's unique ID number. Find it in your API Usage & Settings page. tags: - People Data API security: - RocketReachAPIKey: [] responses: '200': headers: RR-Request-ID: schema: type: string format: uuid description: Lookup unique identifier, will also be sent in the header of webhook. content: application/json: schema: $ref: '#/components/schemas/UniversalCreditPersonLookupOutputWithOptionalMetadata' description: Success. Returns the profile data for the person lookup. '400': headers: RR-Request-ID: schema: type: string format: uuid description: Lookup unique identifier, will also be sent in the header of webhook. description: Bad Request. The request is malformed or missing required parameters. '401': headers: RR-Request-ID: schema: type: string format: uuid description: Lookup unique identifier, will also be sent in the header of webhook. description: Unauthorized. API Key is missing or invalid. '403': headers: RR-Request-ID: schema: type: string format: uuid description: Lookup unique identifier, will also be sent in the header of webhook. description: Forbidden. API Key lacks permission to perform this action. '404': headers: RR-Request-ID: schema: type: string format: uuid description: Lookup unique identifier, will also be sent in the header of webhook. description: Not Found. The requested resource (e.g., profile) does not exist. '429': headers: RR-Request-ID: schema: type: string format: uuid description: Lookup unique identifier, will also be sent in the header of webhook. description: Too Many Requests. API request limit reached -- slow down requests. '500': headers: RR-Request-ID: schema: type: string format: uuid description: Lookup unique identifier, will also be sent in the header of webhook. description: Internal Server Error. Unexpected error on RocketReach servers. Try again later. /universal/person/bulk_lookup: post: operationId: create_universal_person_bulk_lookup description: Bulk People Lookup by Criteria summary: ⭐ Universal Bulk People Lookup API tags: - People Data API requestBody: content: application/json: schema: $ref: '#/components/schemas/UniversalCreditAPIBulkLookupQuery' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/UniversalCreditAPIBulkLookupQuery' multipart/form-data: schema: $ref: '#/components/schemas/UniversalCreditAPIBulkLookupQuery' required: true security: - RocketReachAPIKey: [] responses: '200': headers: RR-Request-ID: schema: type: string format: uuid description: Lookup unique identifier, will also be sent in the header of webhook. description: Success. Bulk lookup request accepted '400': headers: RR-Request-ID: schema: type: string format: uuid description: Lookup unique identifier, will also be sent in the header of webhook. description: Bad Request. The request is malformed or missing required parameters. '401': headers: RR-Request-ID: schema: type: string format: uuid description: Lookup unique identifier, will also be sent in the header of webhook. description: Unauthorized. API Key is missing or invalid. '403': headers: RR-Request-ID: schema: type: string format: uuid description: Lookup unique identifier, will also be sent in the header of webhook. description: Forbidden. API Key lacks permission to perform this action. '404': headers: RR-Request-ID: schema: type: string format: uuid description: Lookup unique identifier, will also be sent in the header of webhook. description: Not Found. The requested resource (e.g., profile) does not exist. '429': headers: RR-Request-ID: schema: type: string format: uuid description: Lookup unique identifier, will also be sent in the header of webhook. description: Too Many Requests. API request limit reached -- slow down requests. '500': headers: RR-Request-ID: schema: type: string format: uuid description: Lookup unique identifier, will also be sent in the header of webhook. description: Internal Server Error. Unexpected error on RocketReach servers. Try again later. /universal/person/check_status: get: operationId: check_universal_person_lookup_status description: Check Universal Person Lookup Status summary: ⭐ Universal People Lookup Status API parameters: - in: query name: ids schema: type: array items: type: integer description: List of Profile IDs tags: - People Data API security: - RocketReachAPIKey: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/UniversalCreditPersonLookupOutput' description: Success. Returns the status and profile data of the requested profiles. '400': description: Bad Request. The request is malformed or missing required parameters. '401': description: Unauthorized. API Key is missing or invalid. '403': description: Forbidden. API Key lacks permission to perform this action. '404': description: Not Found. The requested resource (e.g., profile) does not exist. '429': description: Too Many Requests. API request limit reached -- slow down requests. '500': description: Internal Server Error. Unexpected error on RocketReach servers. Try again later. /person/search: post: operationId: create_person_search description: Search People by Criteria summary: People Search API tags: - People Data API requestBody: content: application/json: schema: $ref: '#/components/schemas/APISearchInput' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/APISearchInput' multipart/form-data: schema: $ref: '#/components/schemas/APISearchInput' required: true security: - RocketReachAPIKey: [] responses: '201': content: application/json: schema: type: array items: $ref: '#/components/schemas/ProfileSearchResultSerializerBase' description: Success. People search request accepted '400': description: Bad Request. The request is malformed or missing required parameters. '401': description: Unauthorized. API Key is missing or invalid. '403': description: Forbidden. API Key lacks permission to perform this action. '404': description: Not Found. The requested resource (e.g., profile) does not exist. '429': description: Too Many Requests. API request limit reached -- slow down requests. '500': description: Internal Server Error. Unexpected error on RocketReach servers. Try again later. x-code-samples: - lang: bash source: "\n curl --request 'POST' --location 'https://api.rocketreach.co/api/v2/person/search'\\\n --header 'Content-Type: application/json'\\\n --data '{\"query\":{\"keyword\":[\"Marc Benioff\"]},\"order_by\":\"popularity\"}'\n " - lang: Python source: "\n search = rr.person.search()\n search = search.filter(current_title='Software Engineer')\n search = search.options(order_by='popularity')\n result = search.execute()\n result.people\n " - lang: Javascript source: "\n let search = rr.people.search()\n search = search.include({name: \"John Smith\"})\n search = search.include({currentTitle: \"CEO\"})\n const results = await search.execute()\n " /universal/person/search: post: operationId: create_universal_person_search description: Search People by Criteria summary: ⭐ Universal People Search API tags: - People Data API requestBody: content: application/json: schema: $ref: '#/components/schemas/APIUniversalCreditsSearchInput' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/APIUniversalCreditsSearchInput' multipart/form-data: schema: $ref: '#/components/schemas/APIUniversalCreditsSearchInput' required: true security: - RocketReachAPIKey: [] responses: '201': content: application/json: schema: type: array items: $ref: '#/components/schemas/UniversalCreditPersonSearchOutput' description: Success. People search request accepted '400': description: Bad Request. The request is malformed or missing required parameters. '401': description: Unauthorized. API Key is missing or invalid. '403': description: Forbidden. API Key lacks permission to perform this action. '404': description: Not Found. The requested resource (e.g., profile) does not exist. '429': description: Too Many Requests. API request limit reached -- slow down requests. '500': description: Internal Server Error. Unexpected error on RocketReach servers. Try again later. x-code-samples: - lang: bash source: "\n curl --request 'POST' --location 'https://api.rocketreach.co/api/v2/universal/person/search'\\\n --header 'Content-Type: application/json'\\\n --data '{\"query\":{\"keyword\":[\"Marc Benioff\"]},\"order_by\":\"popularity\"}'\n " components: schemas: StatusEnum: enum: - complete - progress - searching - not queued type: string ProfileAPICompiledCompany: type: object properties: profile_list: allOf: - $ref: '#/components/schemas/ProfileListAPI' readOnly: true description: Profile List this contact was added to. id: type: integer readOnly: true description: RocketReach internal unique profile ID status: type: string readOnly: true description: Status of the profile lookup. Either "complete", "progress", "searching" or "not queued" example: progress name: type: - string - 'null' maxLength: 128 description: Name of the profile profile_pic: type: - string - 'null' readOnly: true description: URL containing this profile's picture (if available) linkedin_url: type: - string - 'null' readOnly: true description: LinkedIn URL of the profile connections: type: integer description: Number of LinkedIn connections for this profile links: type: object additionalProperties: {} description: Social media links for the profile location: type: - string - 'null' maxLength: 256 description: Location of the profile current_title: type: - string - 'null' readOnly: true description: Current job title of the profile current_employer: type: - string - 'null' readOnly: true description: Current employer of the profile current_employer_id: type: integer description: RocketReach internal unique company ID current_employer_domain: type: - string - 'null' description: Domain for the employer of the profile current_employer_website: type: - string - 'null' description: Website for the employer of the profile current_employer_linkedin_url: type: - string - 'null' description: LinkedIn URL for the employer of the profile current_employer_industry: type: - string - 'null' description: This person's company's industry. job_history: type: array items: $ref: '#/components/schemas/JobHistoryAPICompiledCompany' description: List of professional experiences for the profile education: type: array items: $ref: '#/components/schemas/EducationAPI' description: List of educational experiences for the profile skills: type: - array - 'null' items: type: string description: List of skills for the profile birth_year: type: integer description: Year of birth of the profile region_latitude: type: - number - 'null' format: double description: Latitude of the region of the profile region_longitude: type: - number - 'null' format: double description: Longitude of the region of the profile city: type: - string - 'null' maxLength: 128 description: City of the profile region: type: - string - 'null' maxLength: 3 description: Region of the profile country: type: string readOnly: true description: Country of the profile country_code: type: - string - 'null' maxLength: 2 description: Country code of the profile npi_data: type: object description: List of NPI data objects for the profile properties: npi_number: type: string credentials: type: string license_number: type: string specialization: type: string readOnly: true tags: type: string readOnly: true return_cached_emails: type: boolean readOnly: true description: Indicates if cached emails were returned in the initial synchronous response. If false, email fields will be null until the lookup is complete. linkedin_url_active: type: boolean description: 'Indicates if the LinkedIn profile exists or is no longer available. * `True` = Active (as of last update) * `False` = Unavailable (as of last update)' readOnly: true recommended_email: type: - string - 'null' readOnly: true description: Recommended email for the profile recommended_personal_email: type: - string - 'null' readOnly: true description: Recommended personal email for the profile recommended_professional_email: type: - string - 'null' readOnly: true description: Recommended professional email for the profile current_work_email: type: - string - 'null' readOnly: true description: Current work email for the profile current_personal_email: type: - string - 'null' readOnly: true description: Current personal email for the profile emails: type: array items: $ref: '#/components/schemas/ProfileEmailAPI' readOnly: true description: List of email objects for the profile phones: type: array items: $ref: '#/components/schemas/ProfilePhoneAPI' readOnly: true description: List of phone number objects for the profile UniversalCreditPersonSearchOutput: type: object properties: id: type: integer readOnly: true description: RocketReach internal unique profile ID name: type: - string - 'null' maxLength: 128 description: Name of the profile profile_pic: type: - string - 'null' readOnly: true description: URL containing this profile's picture (if available). linkedin_url: type: - string - 'null' readOnly: true description: LinkedIn URL of the profile connections: type: integer description: Number of LinkedIn connections for this profile location: type: - string - 'null' maxLength: 256 description: Location of the profile city: type: - string - 'null' maxLength: 128 description: City of the profile region: type: - string - 'null' maxLength: 3 description: Region of the profile country: type: string readOnly: true description: Country code of the profile country_code: type: - string - 'null' maxLength: 2 description: Country code of the profile current_title: type: - string - 'null' readOnly: true description: Current job title of the profile current_employer: type: - string - 'null' readOnly: true description: Current employer of the profile current_employer_domain: type: - string - 'null' description: TDomain for the employer of the profile current_employer_website: type: - string - 'null' description: Website for the employer of the profile teaser: type: - object - 'null' properties: emails: type: array items: type: string phones: type: array items: type: object properties: number: type: string is_premium: type: boolean required: - is_premium - number office_phones: type: array items: type: string preview: type: array items: type: string is_premium_phone_available: type: boolean personal_emails: type: array items: type: string professional_emails: type: array items: type: string readOnly: true birth_year: type: integer description: Year of birth of the profile current_employer_id: type: integer description: RocketReach internal unique company ID current_employer_linkedin_url: type: - string - 'null' description: LinkedIn URL for the employer of the profile region_latitude: type: - number - 'null' format: double description: Latitude of the region of the profile region_longitude: type: - number - 'null' format: double description: Longitude of the region of the profile suppressed: type: string readOnly: true description: Returns True if this profile is blocked by a suppression list filter update_time: type: string format: date-time readOnly: true description: Timestamp of the last update for the profile example: '2023-10-01T12:00:00Z' TypedDict: type: object properties: npi_number: type: string readOnly: true description: NPI number of the healthcare provider. An NPI is a unique 10-digit number used to identify health care providers example: 1234567890 credentials: type: string readOnly: true description: Professional qualifications or designations earned by a healthcare provider, such as MD, DO, NP, or RN. license_number: type: string readOnly: true description: A state-issued number that authorizes a healthcare provider to practice in a specific state or field. specialization: type: string readOnly: true description: The specific area of medicine or healthcare in which a provider focuses, such as cardiology, pediatrics, or dermatology. UniversalCreditAPIBulkLookupQuery: type: object properties: queries: type: array items: $ref: '#/components/schemas/UniversalCreditPersonLookupInput' description: Specify the lookup criteria for up to 100 people. profile_list: type: string default: API Bulk Lookup description: Add specified contacts to this profile list. webhook_id: type: integer description: ID of the webhook to post lookup results upon completion. JobHistoryAPICompiledCompany: type: object properties: start_date: type: - string - 'null' description: Start date of the work experience end_date: type: string default: Present description: End date of the work experience (Present if experience is current) company: type: - string - 'null' description: Name of the company company_name: type: string description: Name of the company company_id: type: - integer - 'null' description: RocketReach internal unique company ID company_linkedin_url: type: string readOnly: true description: Linkedin URL of the company company_city: type: string readOnly: true description: City of the company's location company_region: type: string readOnly: true description: Region of the company's location company_country_code: type: string readOnly: true description: Country code of the company's location department: type: string description: Department of the work experience title: type: string description: Job title of the work experience highest_level: type: string description: Highest level of the work experience description: type: string description: Description of the work experience last_updated: type: string format: date-time description: Timestamp of the last update of this work experience sub_department: type: - string - 'null' description: Sub-department of the work experience is_current: type: boolean default: false description: True if the experience is the profile's current role, False otherwise ProfilePhoneAPI: type: object properties: number: type: string description: 'The phone number in international format - Example: `+1 234-555-6789`' example: +1 234-555-6789 e164: type: - string - 'null' description: 'The phone number in E.164 format - Example: `+12345556789`' example: '+12345556789' country_code: type: - string - 'null' description: 'The country code associated with the phone number - Example: `1` for United States' example: '1' extension: type: - string - 'null' description: 'The phone extension, if applicable - Example: `123`' example: '123' type: type: string default: unknown description: 'The type of phone number. Options are `mobile`, `landline`, `work`, `unknown`, `home`, or `fax`. - Example: `mobile`' example: mobile validity: type: string default: unknown description: 'Indicates whether a phone number matches a valid numbering pattern for the country/region. Options are valid or unknown. All invalid phones are removed - Example: `valid`' example: valid recommended: type: boolean default: false description: 'Indicates whether this is the recommended phone number to use as the best option for connecting with the person. - Example: `true`' example: true premium: type: boolean default: false description: '`premium` deprecated' deprecated: true example: true last_checked: type: string format: date-time description: '`last_checked` deprecated' deprecated: true APIUniversalCreditsSearchInput: type: object properties: start: type: integer maximum: 10000 minimum: 1 default: 1 description: Paginate through search results by returning results starting from this value (counting from 1). page_size: type: integer maximum: 100 minimum: 1 default: 100 description: Maximum number of search results to return per page. query: $ref: '#/components/schemas/PersonQuery' order_by: allOf: - $ref: '#/components/schemas/OrderByEnum' default: relevance description: 'Specifies the ordering of search results. "popularity" matches the default ordering of the Search web app. * `relevance` - relevance * `popularity` - popularity * `score` - score' EducationAPI: type: object properties: major: type: - string - 'null' description: Primary field of study of the educational experience school: type: - string - 'null' description: School/University of the educational experience degree: type: - string - 'null' description: Degree obtained through the educational experience start: type: - integer - 'null' description: Start date of the educational experience end: type: - integer - 'null' description: End date of the educational experience ProfileListAPI: type: object properties: id: type: integer readOnly: true description: RocketReach internal unique profile list ID example: 123456 name: type: string readOnly: true description: Name of the profile list example: Example List Name APISearchInput: type: object properties: start: type: integer maximum: 10000 minimum: 1 default: 1 description: Start index of the request results (counting from 1) page_size: type: integer maximum: 100 minimum: 1 default: 10 description: Maximum number of results to return per page [1-100] query: $ref: '#/components/schemas/PersonQuery' description: Search query object for the request order_by: allOf: - $ref: '#/components/schemas/OrderByEnum' default: relevance description: Specifies the ordering of search results. "popularity" matches the default ordering of the Search web app. example: popularity OrderByEnum: enum: - relevance - popularity - score type: string ProfileMatch: type: object properties: id: type: integer description: 'RocketReach internal unique profile ID. - Example: `123456`' example: 123456 name: type: string description: 'Name of the desired profile. Must specify along with `current_employer`. - Example: `Jamie Gullbrand`' example: Jamie Gullbrand current_employer: type: string description: 'Current employer of the desired profile. Must specify along with `name`. - Example: `RocketReach`' example: RocketReach title: type: string description: 'Job title of the desired profile. - Example: `Product Manager`' example: Product Manager linkedin_ext_url: type: string description: linkedin_ext_url deprecated, please use `linkedin_url` pattern: '' deprecated: true linkedin_url: type: string description: 'LinkedIn URL of the desired profile. - Example: `www.linkedin.com/in/jamesgullbrand`' pattern: '' example: www.linkedin.com/in/jamesgullbrand email: type: string format: email description: 'An email address for the desired profile. - Example: `jamie@rocketreach.co`' example: jamie@rocketreach.co npi_number: type: integer description: 'An NPI number for the desired profile (US healthcare professional) - Example: `1234567890`' example: '1234567890' lookup_type: allOf: - $ref: '#/components/schemas/LookupTypeEnum' description: 'Lookup type for the request * `standard` - standard * `premium` - premium * `premium (feeds disabled)` - premium (feeds disabled) * `bulk` - bulk * `phone` - phone * `enrich` - enrich' default: standard example: standard metadata: type: - object - 'null' additionalProperties: {} description: User metadata about the profile, such as external ids, tags, notes, etc. UniversalCreditPersonLookupOutputWithOptionalMetadata: type: object properties: profile_list: allOf: - $ref: '#/components/schemas/ProfileListAPI' readOnly: true description: Profile List this contact was added to. id: type: integer readOnly: true description: RocketReach internal unique profile ID status: type: string readOnly: true description: Status of the profile lookup. Either "complete", "progress", "searching" or "not queued" example: progress name: type: - string - 'null' maxLength: 128 description: Name of the profile profile_pic: type: - string - 'null' readOnly: true description: URL containing this profile's picture (if available). linkedin_url: type: - string - 'null' readOnly: true description: LinkedIn URL of the profile connections: type: integer description: Number of LinkedIn connections for this profile location: type: - string - 'null' maxLength: 256 description: Location of the profile current_title: type: - string - 'null' readOnly: true description: Current job title of the profile current_employer: type: - string - 'null' readOnly: true description: Current employer of the profile current_employer_id: type: integer description: RocketReach internal unique company ID current_employer_domain: type: - string - 'null' description: This person's company's domain name. current_employer_website: type: - string - 'null' description: This person's company's website. current_employer_linkedin_url: type: - string - 'null' description: This person's company's LinkedIn URL. birth_year: type: string description: Year of birth of the profile region_latitude: type: - number - 'null' format: double description: Latitude of the region of the profile region_longitude: type: - number - 'null' format: double description: Longitude of the region of the profile city: type: - string - 'null' maxLength: 128 description: City of the profile region: type: - string - 'null' maxLength: 3 description: Region of the profile country: type: string readOnly: true description: Country of the profile country_code: type: - string - 'null' maxLength: 2 description: Country code of the profile return_cached_emails: type: boolean readOnly: true description: Indicates if cached emails were returned in the initial synchronous response. If false, email fields will be null until the lookup is complete. linkedin_url_active: type: boolean description: 'Indicates if the LinkedIn profile exists or is no longer available. * `True` = Active (as of last update) * `False` = Unavailable (as of last update)' readOnly: true job_history: type: array items: $ref: '#/components/schemas/JobHistoryAPICompiledCompany' description: '[`reveal_detailed_person_enrichment=true` required or this field will not be returned] List of professional experiences for the profile' education: type: array items: $ref: '#/components/schemas/EducationAPI' description: '[`reveal_detailed_person_enrichment=true` required or this field will not be returned] List of educational experiences for the profile' skills: type: - array - 'null' items: type: string description: '[`reveal_detailed_person_enrichment=true` required or this field will not be returned] List of skills for the profile' links: type: object additionalProperties: {} description: '[`reveal_detailed_person_enrichment=true` required or this field will not be returned] Social media links for the profile' npi_data: type: object description: '[`reveal_healthcare_enrichment=true` required or this field will not be returned] List of NPI data objects for the profile' properties: npi_number: type: string credentials: type: string license_number: type: string specialization: type: string readOnly: true recommended_email: type: - string - 'null' readOnly: true description: '[`reveal_personal_email OR reveal_professional_email=true` required or this field will not be returned] Recommended email for the profile' emails: type: array items: $ref: '#/components/schemas/ProfileEmailAPI' readOnly: true description: '[`reveal_personal_email OR reveal_professional_email=true` required or this field will not be returned] List of email objects for the profile' recommended_personal_email: type: - string - 'null' readOnly: true description: '[`reveal_personal_email=true` required or this field will not be returned] Recommended personal email for the profile' current_personal_email: type: - string - 'null' readOnly: true description: '[`reveal_personal_email=true` required or this field will not be returned] Current personal email for the profile' recommended_professional_email: type: - string - 'null' readOnly: true description: '[`reveal_professional_email=true` required or this field will not be returned] Recommended professional email for the profile' current_work_email: type: - string - 'null' readOnly: true description: '[`reveal_professional_email=true` required or this field will not be returned] Current work email for the profile' phones: type: array items: $ref: '#/components/schemas/ProfilePhoneAPI' readOnly: true description: '[`reveal_phone=true` required or this field will not be returned] List of phone number objects for the profile' metadata: type: object additionalProperties: {} readOnly: true description: User metadata associated with the profile lookup ProfileEmailAPI: type: object properties: email: type: string readOnly: true description: 'The email address. - Example: `info@rocketreach.co`' example: info@rocketreach.co smtp_valid: type: - string - 'null' readOnly: true description: 'SMTP validation result. Options are `valid`, `invalid`, `accept-all`, or `unknown`. - Example: `valid`' example: valid type: type: - string - 'null' readOnly: true description: 'The type of email address. Options are `personal`, `professional`, `disposable`, or `role-based`. - Example: `professional`' example: professional last_validation_check: type: - string - 'null' readOnly: true description: 'Timestamp of the last validation check of the email address. - Example: `2026-01-01T12:00:00Z`' example: '2026-01-01T12:00:00Z' grade: type: string readOnly: true description: RocketReach internal grade for the email. See Email Grades for details. example: A- APIBulkLookupQuery: type: object properties: queries: type: array items: $ref: '#/components/schemas/ProfileMatch' description: List of profile lookup queries for between 10 and 100 profiles example: '[''linkedin_url'': ''https://www.linkedin.com/in/benioff''}, etc x10+]' profile_list: type: string default: API Bulk Lookup description: Name of a profile list to add looked up profiles to upon completion example: API Bulk Lookup webhook_id: type: integer description: Webhook ID to post lookup results to upon completion. Find your webhook ID [here](https://rocketreach.co/account?section=nav_gen_api). example: 12345 PersonQuery: type: object properties: all_skills: type: array items: type: string description: 'Include profiles with all of these skills (Uses `AND` logic). - Example: `[''python'', ''sql'', ''machine learning'']`' example: - python - sql - machine learning company_competitors: type: array items: type: string description: 'Include profiles with employers who have these competitors - Example: `[''homedepot.com'']`' example: - homedepot.com company_country_code: type: array items: type: string description: 'Include profiles with employers located in these country codes - Example: `[''US'']`' example: - US company_domain: type: array items: type: string description: 'Include profiles with employers who have these company domains - Example: `[''rocketreach.co'']`' example: - rocketreach.co company_email: type: array items: type: string description: 'Include profiles with employers who have these company emails - Example: `[''info@rocketreach.co'']`' example: - info@rocketreach.co company_funding_max: type: array items: type: string description: 'Include profiles with employers below this amount of funding - Example: `[''50000000'']`' example: - '50000000' company_funding_min: type: array items: type: string description: 'Include profiles with employers above this amount of funding - Example: `[''1000000'']`' example: - '1000000' company_geo: type: array items: type: string description: Include results matching company_geo. company_id: type: array items: type: string description: 'Include profiles with employed by these company IDs - Example: `[''123456'']`' example: - '123456' company_industry: type: array items: type: string description: 'Include profiles with employers in these industries. See the full list of industries [here](https://docs.google.com/spreadsheets/d/1cYz3FwtNEWW7z9otNNZRIILQ63_hM1LQ9SgsXWayaaI/edit?gid=0#gid=0). - Example: `[''Software Engineering'']`' example: - Software Engineering company_industry_keywords: type: array items: type: string description: 'Include profiles with employers with these industry keywords - Example: `[''SaaS'', ''B2B'']`' example: - SaaS - B2B company_intent: type: array items: type: string description: 'Search across 37,000 intent topics found [here](https://docs.google.com/spreadsheets/d/1nnk8ZOLr9GUzrPNy1pG_N_gVIhDpkc5XjE3Hh4J8M00/edit?gid=761283207#gid=761283207). Intent is only available on certain plans. Please reach out to our team to learn more.. - Example: `[''hiring'']`' example: - hiring company_job_posting_signal: type: array items: type: string description: 'Hiring signals that identify companies that are actively building out specific departments. Full list of categories [here](https://docs.google.com/spreadsheets/d/1EZPVnOftbHNwDm0aXjiJ79dSpqcZ4JLnrNJPZxKXi5Q/edit?gid=2100271042#gid=2100271042). - Example: `[''Accounting Roles::one_month'']`' example: - Accounting Roles::one_month company_list: type: array items: type: string description: 'Transforms [ company_list ] search terms into a list of [ company_id ] search terms. - Example: `[''Example Company List'']`' example: - Example Company List company_list_id: type: array items: type: string description: 'Include results matching company_list_id. - Example: `[''12345'']`' example: - '12345' company_naics_code: type: array items: type: string description: 'Include profiles with employers with these NAICS codes - Example: `[''541330'', ''541512'']`' example: - '541330' - '541512' company_name: type: array items: type: string description: 'Include profiles employed by these company names - Example: `[''RocketReach'']`' example: - RocketReach company_news_signal: type: array items: type: string description: 'Search on news events within the 25 categories listed [here](https://docs.google.com/spreadsheets/d/1EZPVnOftbHNwDm0aXjiJ79dSpqcZ4JLnrNJPZxKXi5Q/edit?gid=577464958#gid=577464958"). - Example: `[''Funding::one_month'']`' example: - Funding::one_month company_news_timestamp: type: array items: type: string description: company_news_timestamp deprecated, please use `company_news_signal` deprecated: true example: - mergers & acquisitions::one_month company_publicly_traded: type: array items: type: string description: 'Include results matching company_publicly_traded. - Example: `[''true'']`' example: - 'true' company_revenue: type: array items: type: string description: 'Include profiles with employers with these revenue values. - Example: `[''10000000-50000000'']`' example: - 10000000-50000000 company_sic_code: type: array items: type: string description: 'Include profiles with employers with these SIC codes. - Example: `[''7372'']`' example: - '7372' company_size: type: array items: type: string description: 'Include profiles with employers with these sizes. - Example: `[''51-200'']`' example: - 51-200 company_tag: type: array items: type: string description: 'Include profiles with employers with these company tags. - Example: `[''unicorn'']`' example: - unicorn company_website_url: type: array items: type: string description: 'Include profiles with employers with these website URLs. - Example: `[''rocketreach.co'']`' example: - rocketreach.co connections: type: array items: type: string description: 'Include profiles with these connections. - Example: `[''500+'']`' example: - 500+ contact_method: type: array items: type: string description: 'Include profiles with these contact methods Options are: `mobile`, `phone`, `personal email`, and `work email`. Available with both AND and OR logic. - Example: `["work email OR personal email"]` or `["mobile AND personal email"]`' example: - work email current_or_previous_title: type: array items: type: string description: 'Include results matching current or previous job titles. - Example: `[''VP of Sales'']`' example: - VP of Sales current_title: type: array items: type: string description: 'Include profiles with these current job titles. - Example: `[''Product Manager'']`' example: - Product Manager degree: type: array items: type: string description: 'Include profiles with these degrees. - Example: `[''Bachelors'']`' example: - Bachelors department: type: array items: type: string description: 'Include profiles in these company departments. See the full list of departments [here](https://docs.google.com/spreadsheets/d/1EZPVnOftbHNwDm0aXjiJ79dSpqcZ4JLnrNJPZxKXi5Q/edit?gid=0#gid=0). - Example: `[''Product Management'']`' example: - Product Management description: type: array items: type: string description: 'Include profiles with these descriptions. - Example: `[''Experienced software engineer with a focus on backend development'']`' example: - Experienced software engineer with a focus on backend development domain: type: array items: type: string description: 'Include profiles with these domains. - Example: `[''rocketreach.co'']`' example: - rocketreach.co email: type: array items: type: string description: 'Include profiles with these emails. - Example: `[''john.doe@rocketreach.co'']`' example: - john.doe@rocketreach.co email_grade: type: - string - 'null' description: 'Specifies the minimum email confidence grade that a profile must have. Note: Email grades may be revalidated during lookup. As a result, you may occasionally see profiles whose email grade no longer matches the grade filter used in your search. Use the following format to specify personal or professional email grades: `::` - Allowed Grades: A, A-, or B. - Allowed Modifiers: professional only, personal only - Example: `''A-''` or `''A-::professional only''`' example: A- employer: type: array items: type: string description: 'Include profiles employed by these companies. - Example: `[''RocketReach'']`' example: - RocketReach geo: type: array items: type: string description: 'Include profiles located in these geographies. - Example: `[''North America'']`' example: - North America growth: type: array items: type: string description: 'Include growth numbers for specific departments and time ranges. Format: `min_percentage_growth-max_percentage_growth::Department,TimeRange` * min_percentage_growth: Minimum growth percentage to filter profiles * max_percentage_growth: Maximum growth percentage to filter profiles * Department: Name of the company department (e.g., Engineering, Sales) * TimeRange: Duration for the growth metric (e.g., six_months, one_year) - Example: `[''5-30::Engineering,six_months'']` - Example: `[''-10--20::Sales,one_year'']`' example: - 5-30::Engineering,six_months handle: type: array items: type: string description: 'Include results matching handle. - Example: `[''johndoe'']`' example: - johndoe health_credentials: type: array items: type: string description: 'Include profiles with these health credentials. Only available on certain plans. Please reach out to our team to learn more. - Example: `[''MD'', ''RN'', ''PhD'']`' example: - MD - RN - PhD health_license: type: array items: type: string description: 'Include profiles with these health licenses. Only available on certain plans. Please reach out to our team to learn more. - Example: `[''MA12345'']`' example: - MA12345 health_npi: type: array items: type: string description: 'Include profiles with these health NPIs. Only available on certain plans. Please reach out to our team to learn more. - Example: `[''1234567890'']`' example: - '1234567890' health_specialization: type: array items: type: string description: 'Include profiles with these health specializations. Only available on certain plans. Please reach out to our team to learn more. - Example: `[''Cardiology'']`' example: - Cardiology id: type: array items: type: string description: 'Include profiles with these RocketReach Profile IDs. - Example: `[''123456'']`' example: - '123456' job_change_range_days: type: array items: type: string description: job_change_range_days deprecated, please use `job_change_signal` deprecated: true example: - '30' job_change_signal: type: array items: type: string description: 'Detect when a contact changes companies or gets promoted (Time window options: one_week, one_month, three_months) - Example: `[''Company Change::one_month'']` - Example: `[''Promotion::one_week'']` - Example: `[''Company Change AND Promotion::three_months'']`' example: - Company Change::one_month keyword: type: - string - 'null' description: 'Include results matching keyword. - Example: `[''data enrichment'']`' example: - data enrichment keywords: type: - string - 'null' description: 'Include results matching keywords. - Example: `[''sales prospecting'', ''data enrichment'']`' example: - sales prospecting - data enrichment link: type: array items: type: string description: 'Include results matching link. - Example: `[''https://linkedin.com/in/johndoe'']`' example: - https://linkedin.com/in/johndoe major: type: array items: type: string description: 'Include profiles with these majors. - Example: `[''Computer Science'', ''Biology'']`' example: - Computer Science - Biology management_levels: type: array items: type: string description: 'Include profiles at these management levels. See the full list of management levels [here](https://docs.google.com/spreadsheets/d/1EZPVnOftbHNwDm0aXjiJ79dSpqcZ4JLnrNJPZxKXi5Q/edit?gid=0#gid=0). - Example: `[''Director'']`' example: - Director name: type: array items: type: string description: 'Include profiles with these names. - Example: `[''John Doe'']`' example: - John Doe phone: type: array items: type: string description: 'Include profiles with these phone numbers. - Example: `[''+15555555555'']`' example: - '+15555555555' previous_company_id: type: array items: type: string description: 'Include profiles who were previously employed at these RocketReach company IDs. - Example: `[''123456'']`' example: - '123456' previous_employer: type: array items: type: string description: 'Include profiles who were previously employed at these companies. - Example: `[''Google'']`' example: - Google previous_title: type: array items: type: string description: 'Include results matching previous_title. - Example: `[''Software Engineer'']`' example: - Software Engineer school: type: array items: type: string description: 'Include profiles who attended these schools. - Example: `[''Stanford University'']`' example: - Stanford University skills: type: array items: type: string description: 'Include profiles listed with any of these skills (Uses `OR` logic). - Example: `[''Python'', ''SQL'']`' example: - Python - SQL state: type: array items: type: string description: 'Include profiles located in these states. - Example: `[''MA'']`' example: - MA update_time: type: array items: type: string description: 'Include results that have been updated since the specified date. - Example: `[''2025-01-01'']`' example: - '2025-01-01' years_experience: type: array items: type: string description: 'Include profiles with this many years of experience. - Example: `[''10'']`' example: - '10' UniversalCreditPersonLookupInput: type: object properties: id: type: integer description: RocketReach internal unique profile ID name: type: string description: Name of the desired profile. Must specify along with `current_employer` current_employer: type: string description: Current employer of the desired profile. Must specify along with `name` title: type: string description: Job title of the desired profile linkedin_ext_url: type: string description: linkedin_ext_url deprecated, please use `linkedin_url` pattern: '' deprecated: true linkedin_url: type: string description: LinkedIn URL of the desired profile pattern: '' email: type: string format: email description: An email address for the desired profile npi_number: type: integer description: An NPI number for the desired profile (US healthcare professional) reveal_phone: type: boolean default: false description: Whether to reveal the phone enrichment data for the desired profile reveal_professional_email: type: boolean default: false description: Whether to reveal the professional email enrichment data for the desired profile reveal_personal_email: type: boolean default: false description: Whether to reveal the personal email enrichment data for the desired profile reveal_detailed_person_enrichment: type: boolean default: false description: Whether to reveal the detailed person enrichment data for the desired profile reveal_healthcare_enrichment: type: boolean default: false description: Whether to reveal the healthcare enrichment data for the desired profile metadata: type: - object - 'null' additionalProperties: {} description: User metadata about the profile, such as external ids, tags, notes, etc. ProfileSearchResultSerializerBase: type: object properties: id: type: integer readOnly: true description: RocketReach internal unique profile ID status: allOf: - $ref: '#/components/schemas/StatusEnum' readOnly: true description: Status of the profile lookup name: type: - string - 'null' maxLength: 128 description: Name of the profile profile_pic: type: - string - 'null' readOnly: true description: URL containing this profile's picture (if available). links: type: object additionalProperties: {} description: Social media links for the profile linkedin_url: type: - string - 'null' readOnly: true description: LinkedIn URL of the profile connections: type: integer description: Number of LinkedIn connections for this profile location: type: - string - 'null' maxLength: 256 description: Location of the profile city: type: - string - 'null' maxLength: 128 description: City of the profile region: type: - string - 'null' maxLength: 3 description: Region of the profile country: type: string readOnly: true description: Country code of the profile country_code: type: - string - 'null' maxLength: 2 description: Country code of the profile current_title: type: - string - 'null' readOnly: true description: Current job title of the profile current_employer: type: - string - 'null' readOnly: true description: Current employer of the profile current_employer_domain: type: - string - 'null' description: Domain for the employer of the profile current_employer_website: type: - string - 'null' description: Website for the employer of the profile teaser: type: - object - 'null' properties: emails: type: array items: type: string phones: type: array items: type: object properties: number: type: string is_premium: type: boolean required: - is_premium - number office_phones: type: array items: type: string preview: type: array items: type: string is_premium_phone_available: type: boolean personal_emails: type: array items: type: string professional_emails: type: array items: type: string readOnly: true description: Preview contact data for the profile birth_year: type: integer description: Year of birth of the profile current_employer_id: type: integer description: RocketReach internal unique company ID current_employer_linkedin_url: type: - string - 'null' description: LinkedIn URL for the employer of the profile region_latitude: type: - number - 'null' format: double description: Latitude of the region of the profile region_longitude: type: - number - 'null' format: double description: Longitude of the region of the profile suppressed: type: string readOnly: true description: Returns True if this profile is blocked by a suppression list filter npi_data: allOf: - $ref: '#/components/schemas/TypedDict' readOnly: true description: List of NPI data objects for the profile update_time: type: string format: date-time readOnly: true description: Timestamp of the last update for the profile example: '2023-10-01T12:00:00Z' CompiledCompanyAddress: type: object properties: description: type: string readOnly: true description: Description of the company location street: type: string readOnly: true description: Street of the company address city: type: string readOnly: true description: City of the company address region: type: string readOnly: true description: Region of the company address region_code: type: string readOnly: true description: Region code of the company address postal_code: type: string readOnly: true description: Postal code of the company address country: type: string readOnly: true description: Country of the company address country_code: type: string readOnly: true description: Country code of the company address CompiledCompanyAPI: type: object description: Serializes purchased company fields when looked up. properties: id: type: integer description: RocketReach internal unique company ID example: 123456 name: type: string description: Name of the company domain: type: string description: Web domain for the company email_domain: type: string description: Email domain for the company website_domain: type: - string - 'null' readOnly: true description: Website for the company ticker_symbol: type: - string - 'null' description: Ticker symbol for the company (if available) links: type: - object - 'null' properties: facebook: type: string twitter: type: string linkedin: type: string readOnly: true description: Social media links for the company year_founded: type: - integer - 'null' readOnly: true description: Year the company was founded address: $ref: '#/components/schemas/CompiledCompanyAddress' description: Street address of the company phone: type: - string - 'null' description: Phone number for the company fax: type: - string - 'null' description: Fax number for the company num_employees: type: - integer - 'null' description: Number of employees working at the company revenue: type: - integer - 'null' description: Revenue of the company funding_investors: type: array items: type: string description: List of names of founding investors for the company industry: type: - string - 'null' readOnly: true description: Industry of the company sic_codes: type: array items: type: integer description: List of SIC codes for the company. Standard Industrial Classification (SIC) codes, are four-digit numerical codes used to categorize businesses by their primary industry rr_profile_url: type: string readOnly: true description: URL of the RocketReach company profile page for the company description: type: - string - 'null' description: Description of the company industry_keywords: type: array items: type: string readOnly: true description: List of industry keywords for the company ProfileAPISerializerWithCompiledCompany: type: object properties: profile_list: allOf: - $ref: '#/components/schemas/ProfileListAPI' readOnly: true description: Profile List this contact was added to. id: type: integer readOnly: true description: RocketReach internal unique profile ID status: type: string readOnly: true description: Status of the profile lookup. Either "complete", "progress", "searching" or "not queued" example: progress name: type: - string - 'null' maxLength: 128 description: Name of the profile profile_pic: type: - string - 'null' readOnly: true description: URL containing this profile's picture (if available). linkedin_url: type: - string - 'null' readOnly: true description: LinkedIn URL of the profile connections: type: integer description: Number of LinkedIn connections for this profile links: type: object additionalProperties: {} description: Social media links for the profile location: type: - string - 'null' maxLength: 256 description: Location of the profile current_title: type: - string - 'null' readOnly: true description: Current job title of the profile current_employer: type: - string - 'null' readOnly: true description: Current employer of the profile current_employer_id: type: integer description: RocketReach internal unique company ID current_employer_domain: type: - string - 'null' description: This person's company's domain name. current_employer_website: type: - string - 'null' description: This person's company's website. current_employer_linkedin_url: type: - string - 'null' description: This person's company's LinkedIn URL. current_employer_industry: type: - string - 'null' description: This person's company's industry. job_history: type: array items: $ref: '#/components/schemas/JobHistoryAPICompiledCompany' description: List of professional experiences for the profile education: type: array items: $ref: '#/components/schemas/EducationAPI' description: List of educational experiences for the profile skills: type: - array - 'null' items: type: string description: List of skills for the profile birth_year: type: integer description: Year of birth of the profile region_latitude: type: - number - 'null' format: double description: Latitude of the region of the profile region_longitude: type: - number - 'null' format: double description: Longitude of the region of the profile city: type: - string - 'null' maxLength: 128 description: City of the profile region: type: - string - 'null' maxLength: 3 description: Region of the profile country: type: string readOnly: true description: Country of the profile country_code: type: - string - 'null' maxLength: 2 description: Country code of the profile npi_data: type: object description: List of NPI data objects for the profile properties: npi_number: type: string credentials: type: string license_number: type: string specialization: type: string readOnly: true tags: type: string readOnly: true return_cached_emails: type: boolean readOnly: true description: Indicates if cached emails were returned in the initial synchronous response. If false, email fields will be null until the lookup is complete. linkedin_url_active: type: boolean description: 'Indicates if the LinkedIn profile exists or is no longer available. * `True` = Active (as of last update) * `False` = Unavailable (as of last update)' readOnly: true recommended_email: type: - string - 'null' readOnly: true description: Recommended email for the profile recommended_personal_email: type: - string - 'null' readOnly: true description: Recommended personal email for the profile recommended_professional_email: type: - string - 'null' readOnly: true description: Recommended professional email for the profile current_work_email: type: - string - 'null' readOnly: true description: Current work email for the profile current_personal_email: type: - string - 'null' readOnly: true description: Current personal email for the profile emails: type: array items: $ref: '#/components/schemas/ProfileEmailAPI' readOnly: true description: List of email objects for the profile phones: type: array items: $ref: '#/components/schemas/ProfilePhoneAPI' readOnly: true description: List of phone number objects for the profile company: $ref: '#/components/schemas/CompiledCompanyAPI' description: Object representing the employer of the profile LookupTypeEnum: enum: - standard - premium - premium (feeds disabled) - bulk - phone - enrich type: string description: '* `standard` - standard * `premium` - premium * `premium (feeds disabled)` - premium (feeds disabled) * `bulk` - bulk * `phone` - phone * `enrich` - enrich' UniversalCreditPersonLookupOutput: type: object properties: profile_list: allOf: - $ref: '#/components/schemas/ProfileListAPI' readOnly: true description: Profile List this contact was added to. id: type: integer readOnly: true description: RocketReach internal unique profile ID status: type: string readOnly: true description: Status of the profile lookup. Either "complete", "progress", "searching" or "not queued" example: progress name: type: - string - 'null' maxLength: 128 description: Name of the profile profile_pic: type: - string - 'null' readOnly: true description: URL containing this profile's picture (if available). linkedin_url: type: - string - 'null' readOnly: true description: LinkedIn URL of the profile connections: type: integer description: Number of LinkedIn connections for this profile location: type: - string - 'null' maxLength: 256 description: Location of the profile current_title: type: - string - 'null' readOnly: true description: Current job title of the profile current_employer: type: - string - 'null' readOnly: true description: Current employer of the profile current_employer_id: type: integer description: RocketReach internal unique company ID current_employer_domain: type: - string - 'null' description: This person's company's domain name. current_employer_website: type: - string - 'null' description: This person's company's website. current_employer_linkedin_url: type: - string - 'null' description: This person's company's LinkedIn URL. birth_year: type: string description: Year of birth of the profile region_latitude: type: - number - 'null' format: double description: Latitude of the region of the profile region_longitude: type: - number - 'null' format: double description: Longitude of the region of the profile city: type: - string - 'null' maxLength: 128 description: City of the profile region: type: - string - 'null' maxLength: 3 description: Region of the profile country: type: string readOnly: true description: Country of the profile country_code: type: - string - 'null' maxLength: 2 description: Country code of the profile return_cached_emails: type: boolean readOnly: true description: Indicates if cached emails were returned in the initial synchronous response. If false, email fields will be null until the lookup is complete. linkedin_url_active: type: boolean description: 'Indicates if the LinkedIn profile exists or is no longer available. * `True` = Active (as of last update) * `False` = Unavailable (as of last update)' readOnly: true job_history: type: array items: $ref: '#/components/schemas/JobHistoryAPICompiledCompany' description: '[`reveal_detailed_person_enrichment=true` required or this field will not be returned] List of professional experiences for the profile' education: type: array items: $ref: '#/components/schemas/EducationAPI' description: '[`reveal_detailed_person_enrichment=true` required or this field will not be returned] List of educational experiences for the profile' skills: type: - array - 'null' items: type: string description: '[`reveal_detailed_person_enrichment=true` required or this field will not be returned] List of skills for the profile' links: type: object additionalProperties: {} description: '[`reveal_detailed_person_enrichment=true` required or this field will not be returned] Social media links for the profile' npi_data: type: object description: '[`reveal_healthcare_enrichment=true` required or this field will not be returned] List of NPI data objects for the profile' properties: npi_number: type: string credentials: type: string license_number: type: string specialization: type: string readOnly: true recommended_email: type: - string - 'null' readOnly: true description: '[`reveal_personal_email OR reveal_professional_email=true` required or this field will not be returned] Recommended email for the profile' emails: type: array items: $ref: '#/components/schemas/ProfileEmailAPI' readOnly: true description: '[`reveal_personal_email OR reveal_professional_email=true` required or this field will not be returned] List of email objects for the profile' recommended_personal_email: type: - string - 'null' readOnly: true description: '[`reveal_personal_email=true` required or this field will not be returned] Recommended personal email for the profile' current_personal_email: type: - string - 'null' readOnly: true description: '[`reveal_personal_email=true` required or this field will not be returned] Current personal email for the profile' recommended_professional_email: type: - string - 'null' readOnly: true description: '[`reveal_professional_email=true` required or this field will not be returned] Recommended professional email for the profile' current_work_email: type: - string - 'null' readOnly: true description: '[`reveal_professional_email=true` required or this field will not be returned] Current work email for the profile' phones: type: array items: $ref: '#/components/schemas/ProfilePhoneAPI' readOnly: true description: '[`reveal_phone=true` required or this field will not be returned] List of phone number objects for the profile' securitySchemes: RocketReachAPIKey: type: apiKey name: Api-Key in: header description: RocketReach account API key. You can locate your API Key from the "My API Key" section of the [API account page](https://rocketreach.co/account?section=nav_gen_api). Requests to the API are authenticated using the Api-Key request header. Older clients may use an `api_key` query parameter, but this behavior is deprecated.