### Person Search Response Example Source: https://nymeria.io/developers This is an example of a successful response when searching for a person. It includes the status, metadata about the search, and the data for the found person, such as contact information and job details. ```json { "status": 200, "meta": { "first_name": "steve", "last_name": "wozniak", "limit": "1", "offset": "0" }, "data": [ { "uuid": "2daa700e-ab74-4be9-bf88-dd1b8a94efcd", "first_name": "steve", "last_name": "wozniak", "location": "palo alto, california", "country": "united states", "job_title": "co-founder", "job_company_name": "apple", "industry": "technology", "personal_emails": ["*****@icloud.com"], "work_email": "*****@apple.com", "mobile_phone": null, "linkedin_username": "wozniaksteve" } ], "total": 1 } ``` -------------------------------- ### Search Companies by Name and Limit Source: https://nymeria.io/developers Use the company search endpoint to find companies matching specific criteria like name and location. Optional parameters like limit and offset can control the response size and starting point. A 404 is returned if no companies match, otherwise 1 credit is consumed per company returned. ```HTTP GET https://www.nymeria.io/api/v4/company/search?name=nymeria&limit=1 ``` ```JSON { "status": 200, "metadata": { "name": "nymeria", "limit": "1", "offset": "0" }, "data": [ { "uuid": "fe6ad720-8c76-45c5-a794-1c92cfea6270", "name": "nymeria", "url": "nymeria.io", "size": "1-10", "founded": "2017", "industry": "computer software", "location": "cedar city, utah", "country": "united states", "linkedin_id": "19213208", "linkedin_url": "linkedin.com/company/nymeria" } ], "total": 1 } ``` -------------------------------- ### Single Person Enrichment Request Source: https://nymeria.io/developers Use the GET request to enrich a single person's profile by providing a LinkedIn username. This endpoint returns a comprehensive profile with contact information if a match is found. ```http GET https://www.nymeria.io/api/v4/person/enrich?linkedin_username=wozniaksteve ``` -------------------------------- ### Authorize API Request with API Key Source: https://nymeria.io/developers Use the X-API-Key header to authenticate your API requests. Ensure your API key is kept secure and not exposed in public code. ```shell $ curl -H "X-API-Key: YOUR-KEY" ... ``` -------------------------------- ### Search for a Person by Name Source: https://nymeria.io/developers Use this endpoint to find a specific person by providing their first and last name. The `limit` parameter can be used to control the number of results returned. ```bash GET https://www.nymeria.io/api/v4/person/search?first_name=steve&last_name=wozniak&limit=1 ``` -------------------------------- ### Search Companies Source: https://nymeria.io/developers Searches for one or more companies matching the provided search parameters. Returns a set of companies that match, with all matches returned as complete company profiles. Consumes 1 credit for each company returned. If no companies are found, a 404 response is returned and no credit is consumed. ```APIDOC ## GET /api/v4/company/search ### Description Searches for one or more companies matching the provided search parameters. Returns a set of companies that match, with all matches returned as complete company profiles. Consumes 1 credit for each company returned. If no companies are found, a 404 response is returned and no credit is consumed. ### Method GET ### Endpoint /api/v4/company/search ### Parameters #### Query Parameters - **name** (string) - Optional - A company name. - **location** (string) - Optional - A location (city, state). - **country** (string) - Optional - A country (e.g., united states). - **industry** (string) - Optional - An associated industry. - **size** (string) - Optional - A given employee size. - **limit** (integer) - Optional - The maximum number of results to return. Default is 10, can be from 1 to 25. - **offset** (integer) - Optional - The number of results to skip. Default is 0, can be from 0 to 9999. ### Request Example ``` GET https://www.nymeria.io/api/v4/company/search?name=nymeria&limit=1 ``` ### Response #### Success Response (200) - **metadata** (object) - Contains information about the search query. - **name** (string) - The search term used for the company name. - **limit** (string) - The limit applied to the search results. - **offset** (string) - The offset applied to the search results. - **data** (array) - An array of company profiles matching the search criteria. - **uuid** (string) - Unique identifier for the company. - **name** (string) - The name of the company. - **url** (string) - The website URL of the company. - **size** (string) - The employee size of the company. - **founded** (string) - The founding year of the company. - **industry** (string) - The industry the company operates in. - **location** (string) - The location of the company. - **country** (string) - The country the company is based in. - **linkedin_id** (string) - The LinkedIn ID of the company. - **linkedin_url** (string) - The LinkedIn profile URL of the company. - **total** (integer) - The total number of companies found. #### Response Example ```json { "status": 200, "metadata": { "name": "nymeria", "limit": "1", "offset": "0" }, "data": [ { "uuid": "fe6ad720-8c76-45c5-a794-1c92cfea6270", "name": "nymeria", "url": "nymeria.io", "size": "1-10", "founded": "2017", "industry": "computer software", "location": "cedar city, utah", "country": "united states", "linkedin_id": "19213208", "linkedin_url": "linkedin.com/company/nymeria" } ], "total": 1 } ``` ``` -------------------------------- ### Bulk Person Enrichment Endpoint Source: https://nymeria.io/developers Perform bulk enrichment by sending a POST request to the bulk endpoint with a JSON content type. The request body should contain an array of enrichment requests, each with parameters and optional metadata. ```http POST https://www.nymeria.io/api/v4/person/enrich/bulk ``` -------------------------------- ### Enrich Company Source: https://nymeria.io/developers Enriches company information by taking parameters such as a company's name or website URL and returns the matching company profile. Consumes 1 credit if a company is found. ```APIDOC ## GET /api/v4/company/enrich ### Description Enriches company information by taking parameters such as a company's name or website URL and returns the matching company profile. Consumes 1 credit if a company is found. If no company is matched a 404 response will be returned and no credit is consumed. ### Method GET ### Endpoint /api/v4/company/enrich ### Parameters #### Query Parameters - **name** (string) - Optional - The company's name. - **website** (string) - Optional - The company's official website URL. - **profile** (string) - Optional - The company's LinkedIn URL. - **linkedin_id** (string) - Optional - The numeric ID for the company's LinkedIn profile. ### Request Example ``` GET https://www.nymeria.io/api/v4/company/enrich?linkedin_id=19213208 ``` ### Response #### Success Response (200) - **uuid** (string) - Unique identifier for the company. - **name** (string) - The name of the company. - **url** (string) - The website URL of the company. - **size** (string) - The employee size of the company. - **founded** (string) - The founding year of the company. - **industry** (string) - The industry the company operates in. - **location** (string) - The location of the company. - **country** (string) - The country the company is based in. - **linkedin_id** (string) - The LinkedIn ID of the company. - **linkedin_url** (string) - The LinkedIn profile URL of the company. #### Response Example ```json { "status": 200, "data": { "uuid": "fe6ad720-8c76-45c5-a794-1c92cfea6270", "name": "nymeria", "url": "nymeria.io", "size": "1-10", "founded": "2017", "industry": "computer software", "location": "cedar city, utah", "country": "united states", "linkedin_id": "19213208", "linkedin_url": "linkedin.com/company/nymeria" } } ``` ``` -------------------------------- ### Nymeria API Successful Response Format Source: https://nymeria.io/developers Examine the structure of successful responses, which contain metadata, original parameters, a 200 status code, and a 'data' field holding the requested information. ```json { "metadata": { "id": "foobar" }, "params": { "linkedin_username": "billgates" }, "status": 200, "data": { ... } /* single object (enrichment) or array of objects (search) */ } ``` -------------------------------- ### Search People Source: https://nymeria.io/developers Searches for one or more people matching the provided search criteria. Returns a set of people with complete contact information. ```APIDOC ## GET /api/v4/person/search ### Description Searches for people based on specified criteria and returns matching individuals with their contact information. ### Method GET ### Endpoint /api/v4/person/search ### Parameters #### Query Parameters - **first_name** (string) - Optional - The person's given name. - **last_name** (string) - Optional - The person's family name. - **location** (string) - Optional - A location (city, state). - **country** (string) - Optional - A country (e.g., united states). - **industry** (string) - Optional - A given industry. - **title** (string) - Optional - The person's current job title. - **company** (string) - Optional - The person's current company. - **limit** (integer) - Optional - Controls the number of results returned. Defaults to 10. Can be between 1 and 25. - **offset** (integer) - Optional - Controls the starting point for results. Defaults to 0. Can be from 0 to 9999. ### Request Example ``` GET https://www.nymeria.io/api/v4/person/search?first_name=steve&last_name=wozniak&limit=1 ``` ### Response #### Success Response (200) - **status** (integer) - The HTTP status code. - **meta** (object) - Metadata about the search query. - **first_name** (string) - The first name used in the query. - **last_name** (string) - The last name used in the query. - **limit** (string) - The limit parameter used in the query. - **offset** (string) - The offset parameter used in the query. - **data** (array) - An array of person objects matching the search criteria. - **uuid** (string) - Unique identifier for the person. - **first_name** (string) - The person's given name. - **last_name** (string) - The person's family name. - **location** (string) - The person's location. - **country** (string) - The person's country. - **job_title** (string) - The person's current job title. - **job_company_name** (string) - The person's current company name. - **industry** (string) - The person's industry. - **personal_emails** (array) - An array of personal email addresses. - **work_email** (string) - The person's work email address. - **mobile_phone** (string or null) - The person's mobile phone number. - **linkedin_username** (string) - The person's LinkedIn username. - **total** (integer) - The total number of people found. #### Response Example ```json { "status": 200, "meta": { "first_name": "steve", "last_name": "wozniak", "limit": "1", "offset": "0" }, "data": [ { "uuid": "2daa700e-ab74-4be9-bf88-dd1b8a94efcd", "first_name": "steve", "last_name": "wozniak", "location": "palo alto, california", "country": "united states", "job_title": "co-founder", "job_company_name": "apple", "industry": "technology", "personal_emails": ["*****@icloud.com"], "work_email": "*****@apple.com", "mobile_phone": null, "linkedin_username": "wozniaksteve" } ], "total": 1 } ``` ### Error Handling - **404 Not Found**: Returned if no people match the search criteria. ``` -------------------------------- ### Bulk Person Enrichment Source: https://nymeria.io/developers Performs bulk enrichment of person profiles. Accepts a JSON payload containing multiple enrichment requests. ```APIDOC ## POST /api/v4/person/enrich/bulk ### Description Performs bulk enrichment of person profiles. Accepts a JSON payload containing multiple enrichment requests. ### Method POST ### Endpoint /api/v4/person/enrich/bulk ### Parameters #### Request Body - **requests** (array) - Required - An array of enrichment request objects. - **params** (object) - Required - Parameters for a single enrichment request. - **profile** (string) - Optional - A public profile URL. - **lid** (string) - Optional - A numeric LinkedIn identifier. - **email** (string) - Optional - Any email address associated with a person. - **require** (string) - Optional - A comma-separated list of required response fields. - **metadata** (object) - Optional - Custom metadata to associate with the request. ### Request Example ```json { "requests": [ { "params": { "linkedin_url": "linkedin.com/in/wessels-smith-bab84996" }, "metadata": { "my-id": "some-internal-id" } }, { "params": { "email": "wozniak.steve@icloud.com" } } ] } ``` ### Response #### Success Response (200) - **status** (integer) - The status code of the individual request. - **metadata** (object) - Metadata associated with the request. - **params** (object) - Parameters used for the request. - **data** (object) - The enriched person data if successful. - **error** (object) - Error details if the request failed. - **type** (string) - The type of error. - **message** (string) - A description of the error. #### Response Example ```json { "status": 200, "data": [ { "status": 404, "metadata": { "my-id": "some-internal-id" }, "params": { "url": "linkedin.com/in/wessels-smith-bab84996" }, "error": { "type": "not_found", "message": "There were no records found matching your request." } }, { "status": 200, "metadata": null, "params": { "email": "wozniak.steve@icloud.com" }, "data": { "uuid": "2daa700e-ab74-4be9-bf88-dd1b8a94efcd", "first_name": "steve", "last_name": "wozniak", "location_name": "palo alto, california", "location_country": "united states", "job_title": "co-founder", "job_company_name": "apple", "industry": "technology", "personal_emails": ["*****@icloud.com"], "work_email": "*****@apple.com", "mobile_phone": null, "linkedin_username": "wozniaksteve" } } ] } ``` ``` -------------------------------- ### Nymeria API Error Response Format Source: https://nymeria.io/developers Understand the structure of error responses, which include metadata, original parameters, status code, and an error object detailing the issue. ```json { "metadata": { "id": "foobar" }, "params": { "linkedin_username": "wozniaksteve" }, "status": 404, "error": { "type": "not_found", "message": "There were no records found matching your request." } } ``` -------------------------------- ### Bulk Person Enrichment Request Body Source: https://nymeria.io/developers The request body for bulk enrichment uses a JSON format, specifying an array of 'requests'. Each request can include parameters like 'linkedin_url' or 'email', and optional 'metadata' for tracking. ```json { "requests": [ { "params": { "linkedin_url": "linkedin.com/in/wessels-smith-bab84996" }, "metadata": { "my-id": "some-internal-id" } }, { "params": { "email": "wozniak.steve@icloud.com" } } ] } ``` -------------------------------- ### Single Person Enrichment Source: https://nymeria.io/developers Enriches a person's profile using a social media URL, LinkedIn ID, or email address. Returns complete profile information including contact details. ```APIDOC ## GET /api/v4/person/enrich ### Description Enriches a person's profile using a social media URL, LinkedIn ID, or email address. Returns complete profile information including contact details. ### Method GET ### Endpoint /api/v4/person/enrich ### Parameters #### Query Parameters - **profile** (string) - Required - A public profile URL (e.g., LinkedIn, GitHub). - **lid** (string) - Required - A numeric LinkedIn identifier. - **email** (string) - Required - Any email address associated with a person. - **require** (string) - Optional - A comma-separated list of required response fields (e.g., `email`, `phone`, `personal-email`, `professional-email`). ### Response #### Success Response (200) - **uuid** (string) - Unique identifier for the person. - **first_name** (string) - The person's first name. - **last_name** (string) - The person's last name. - **location_name** (string) - The person's location. - **location_country** (string) - The person's country. - **job_title** (string) - The person's job title. - **job_company_name** (string) - The company the person works for. - **industry** (string) - The industry the person works in. - **personal_emails** (array) - An array of personal email addresses. - **work_email** (string) - The person's work email address. - **mobile_phone** (string) - The person's mobile phone number. - **linkedin_username** (string) - The person's LinkedIn username. #### Response Example ```json { "status": 200, "data": { "uuid": "a2528c93-c11c-4d30-b9c2-1d413ec93bb3", "first_name": "steve", "last_name": "wozniak", "location_name": "palo alto, california", "location_country": "united states", "job_title": "founder", "job_company_name": "apple", "industry": "technology", "personal_emails": ["*****@icloud.com"], "work_email": "*****@apple.com", "mobile_phone": null, "linkedin_username": "wozniaksteve" } } ``` #### Error Response (404) Returned if no person is matched or if specified requirements are not met. ``` -------------------------------- ### Single Person Enrichment Response Source: https://nymeria.io/developers A successful response to a single person enrichment request includes a 200 status and detailed person data, such as name, location, job information, and contact details. ```json { "status": 200, "data": { "uuid": "a2528c93-c11c-4d30-b9c2-1d413ec93bb3", "first_name": "steve", "last_name": "wozniak", "location_name": "palo alto, california", "location_country": "united states", "job_title": "founder", "job_company_name": "apple", "industry": "technology", "personal_emails": ["*****@icloud.com"], "work_email": "*****@apple.com", "mobile_phone": null, "linkedin_username": "wozniaksteve" } } ``` -------------------------------- ### Enrich Company by LinkedIn ID Source: https://nymeria.io/developers Use the company enrichment endpoint to retrieve a company's profile using its LinkedIn ID. A 404 is returned if no match is found, otherwise 1 credit is consumed. ```HTTP GET https://www.nymeria.io/api/v4/company/enrich?linkedin_id=19213208 ``` ```JSON { "status": 200, "data": { "uuid": "fe6ad720-8c76-45c5-a794-1c92cfea6270", "name": "nymeria", "url": "nymeria.io", "size": "1-10", "founded": "2017", "industry": "computer software", "location": "cedar city, utah", "country": "united states", "linkedin_id": "19213208", "linkedin_url": "linkedin.com/company/nymeria" } } ``` -------------------------------- ### Bulk Person Enrichment Response Source: https://nymeria.io/developers The bulk enrichment response is an array of objects, each corresponding to a request. It includes status, metadata, parameters, and either data for a successful match or an error object for a 404 response. ```json { "status": 200, "data": [ { "status": 404, "metadata": { "my-id": "some-internal-id" }, "params": { "url": "linkedin.com/in/wessels-smith-bab84996" }, "error": { "type": "not_found", "message": "There were no records found matching your request." } }, { "status": 200, "metadata": null, "params": { "email": "wozniak.steve@icloud.com" }, "data": { "uuid": "2daa700e-ab74-4be9-bf88-dd1b8a94efcd", "first_name": "steve", "last_name": "wozniak", "location_name": "palo alto, california", "location_country": "united states", "job_title": "co-founder", "job_company_name": "apple", "industry": "technology", "personal_emails": ["*****@icloud.com"], "work_email": "*****@apple.com", "mobile_phone": null, "linkedin_username": "wozniaksteve" } } ] } ``` === COMPLETE CONTENT === This response contains all available snippets from this library. No additional content exists. Do not make further requests.