{ "openapi": "3.1.0", "info": { "title": "Enrich Layer API v3", "version": "0.2.0", "description": "Successful requests consume API credits. Failed requests (4xx/5xx) are not charged.", "contact": { "name": "Enrich Layer support", "email": "support@enrichlayer.com" } }, "servers": [ { "url": "https://api.enrichlayer.com" } ], "security": [ { "BearerAuth": [] } ], "tags": [ { "name": "people", "description": "Person enrichment" }, { "name": "company", "description": "Company search" } ], "paths": { "/v3/person": { "get": { "operationId": "getPersonV3", "summary": "Person Profile Endpoint", "description": "Look up a person by any identifier: an email address, or a LinkedIn, Facebook, Twitter/X, or GitHub username or profile URL. One of them is required.", "tags": [ "people" ], "x-codeSamples": [ { "id": "curl", "label": "cURL", "lang": "bash", "source": "curl -X GET \"https://api.enrichlayer.com/v3/person?profile=https%3A%2F%2Flinkedin.com%2Fin%2Fsatyanadella%2F&personalEmail=include&maxAgeSeconds=86400\" \\\n -H \"Authorization: Bearer YOUR_API_KEY\"" }, { "id": "js", "label": "JavaScript", "lang": "js", "source": "const response = await fetch(\"https://api.enrichlayer.com/v3/person?profile=https%3A%2F%2Flinkedin.com%2Fin%2Fsatyanadella%2F&personalEmail=include&maxAgeSeconds=86400\", {\n headers: { Authorization: \"Bearer YOUR_API_KEY\" }\n});\n\nconst person = await response.json();" }, { "id": "go", "label": "Go", "lang": "go", "source": "req, _ := http.NewRequest(\"GET\", \"https://api.enrichlayer.com/v3/person?profile=https%3A%2F%2Flinkedin.com%2Fin%2Fsatyanadella%2F&personalEmail=include&maxAgeSeconds=86400\", nil)\nreq.Header.Set(\"Authorization\", \"Bearer YOUR_API_KEY\")\n\nresp, err := http.DefaultClient.Do(req)" }, { "id": "python", "label": "Python", "lang": "python", "source": "import requests\n\nresponse = requests.get(\n \"https://api.enrichlayer.com/v3/person?profile=https%3A%2F%2Flinkedin.com%2Fin%2Fsatyanadella%2F&personalEmail=include&maxAgeSeconds=86400\",\n headers={\"Authorization\": \"Bearer YOUR_API_KEY\"},\n)\nperson = response.json()" }, { "id": "java", "label": "Java", "lang": "java", "source": "HttpRequest request = HttpRequest.newBuilder()\n .uri(URI.create(\"https://api.enrichlayer.com/v3/person?profile=https%3A%2F%2Flinkedin.com%2Fin%2Fsatyanadella%2F&personalEmail=include&maxAgeSeconds=86400\"))\n .header(\"Authorization\", \"Bearer YOUR_API_KEY\")\n .build();\n\nHttpResponse response = HttpClient.newHttpClient()\n .send(request, HttpResponse.BodyHandlers.ofString());" }, { "id": "csharp", "label": "C#", "lang": "csharp", "source": "using var client = new HttpClient();\nclient.DefaultRequestHeaders.Authorization =\n new AuthenticationHeaderValue(\"Bearer\", \"YOUR_API_KEY\");\n\nvar person = await client.GetStringAsync(\"https://api.enrichlayer.com/v3/person?profile=https%3A%2F%2Flinkedin.com%2Fin%2Fsatyanadella%2F&personalEmail=include&maxAgeSeconds=86400\");" } ], "parameters": [ { "name": "email", "in": "query", "required": false, "description": "Email address", "example": "satya@microsoft.com", "schema": { "type": "string" } }, { "name": "profile", "in": "query", "required": false, "description": "LinkedIn username or profile URL", "example": "https://linkedin.com/in/satyanadella/", "schema": { "type": "string" } }, { "name": "facebook", "in": "query", "required": false, "description": "Facebook username or profile URL", "example": "https://facebook.com/satyanadella/", "schema": { "type": "string" } }, { "name": "twitter", "in": "query", "required": false, "description": "Twitter/X username or profile URL", "example": "https://x.com/satyanadella/", "schema": { "type": "string" } }, { "name": "github", "in": "query", "required": false, "description": "GitHub username or profile URL", "example": "https://github.com/desaturne", "schema": { "type": "string" } }, { "name": "socialLink", "in": "query", "required": false, "description": "Include the social profile URLs, returned in the `contactInformation.socialLinks` section, along with the corresponding usernames in the `slug` section", "example": "include", "schema": { "default": "exclude", "type": "string", "enum": [ "exclude", "include" ] } }, { "name": "phoneNumber", "in": "query", "required": false, "description": "Include phone numbers, returned in the `contactInformation.phoneNumbers` section", "example": "include", "schema": { "default": "exclude", "type": "string", "enum": [ "exclude", "include" ] } }, { "name": "personalEmail", "in": "query", "required": false, "description": "Include personal emails, returned in the `contactInformation.emails.personal` section", "example": "include", "schema": { "default": "exclude", "type": "string", "enum": [ "exclude", "include" ] } }, { "name": "workEmail", "in": "query", "required": false, "description": "Include work emails, returned in the `contactInformation.emails.work` section", "example": "include", "schema": { "default": "exclude", "type": "string", "enum": [ "exclude", "include" ] } }, { "name": "careerInsight", "in": "query", "required": false, "description": "Include the estimated salary, seniority, and inferred skills, returned in the `careerInsight` section", "example": "include", "schema": { "default": "exclude", "type": "string", "enum": [ "exclude", "include" ] } }, { "name": "developerProfile", "in": "query", "required": false, "description": "Include the GitHub developer profile data, returned in the `developerProfile` section", "example": "include", "schema": { "default": "exclude", "type": "string", "enum": [ "exclude", "include" ] } }, { "name": "maxAgeSeconds", "in": "query", "required": false, "description": "Maximum acceptable age of cached data, in seconds.", "example": 86400, "schema": { "default": 2592000, "type": "integer", "minimum": 0 } } ], "responses": { "200": { "description": "The enriched v3 person profile", "headers": { "X-Request-Id": { "$ref": "#/components/headers/X-Request-Id" } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "summary": { "type": "object", "properties": { "fullName": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "profileImage": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "jobTitle": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "currentCompanies": { "type": "array", "items": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "location": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "fullName", "profileImage", "jobTitle", "currentCompanies", "location" ], "additionalProperties": false }, "slug": { "type": "object", "properties": { "linkedin": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "github": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "facebook": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "twitter": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "linkedin", "github", "facebook", "twitter" ], "additionalProperties": false }, "profileImageUrl": { "type": "object", "properties": { "linkedin": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "twitter": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "github": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "linkedin", "twitter", "github" ], "additionalProperties": false }, "backgroundImageUrl": { "type": "object", "properties": { "linkedin": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "twitter": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "github": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "linkedin", "twitter", "github" ], "additionalProperties": false }, "firstName": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "lastName": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "fullName": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "middleName": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "nickname": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "suffix": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "headline": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "headlineTimeseries": { "type": "array", "items": { "type": "object", "properties": { "date": { "type": "string" }, "value": { "anyOf": [ { "type": "number" }, { "type": "string" } ] } }, "required": [ "date", "value" ], "additionalProperties": false } }, "jobTitle": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "about": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "location": { "type": "object", "properties": { "country": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "countryIso3": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "countryFullName": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "city": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "state": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "stateFullName": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "rawLocationString": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "coordinates": { "anyOf": [ { "type": "object", "properties": { "latitude": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "longitude": { "anyOf": [ { "type": "number" }, { "type": "null" } ] } }, "required": [ "latitude", "longitude" ], "additionalProperties": false }, { "type": "null" } ] } }, "required": [ "country", "countryIso3", "countryFullName", "city", "state", "stateFullName", "rawLocationString", "coordinates" ], "additionalProperties": false }, "experience": { "type": "object", "properties": { "work": { "type": "array", "items": { "type": "object", "properties": { "startDate": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "endDate": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "companyName": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "companyInfo": { "anyOf": [ { "type": "object", "properties": { "linkedin": { "anyOf": [ { "type": "object", "properties": { "slug": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "companyId": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "logoUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "website": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "industries": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] } }, "required": [ "slug", "companyId", "logoUrl", "website", "industries" ], "additionalProperties": false }, { "type": "null" } ] }, "facebook": { "anyOf": [ { "type": "object", "properties": { "slug": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "companyId": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "logoUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "website": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "industries": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] } }, "required": [ "slug", "companyId", "logoUrl", "website", "industries" ], "additionalProperties": false }, { "type": "null" } ] }, "crunchbase": { "anyOf": [ { "type": "object", "properties": { "slug": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "companyId": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "logoUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "website": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "industries": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] } }, "required": [ "slug", "companyId", "logoUrl", "website", "industries" ], "additionalProperties": false }, { "type": "null" } ] }, "twitter": { "anyOf": [ { "type": "object", "properties": { "slug": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "companyId": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "logoUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "website": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "industries": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] } }, "required": [ "slug", "companyId", "logoUrl", "website", "industries" ], "additionalProperties": false }, { "type": "null" } ] } }, "required": [ "linkedin", "facebook", "crunchbase", "twitter" ], "additionalProperties": false }, { "type": "null" } ] }, "title": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "location": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "seniority": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] }, "isDecisionMaker": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "employmentType": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] }, "jobFunction": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] } }, "required": [ "startDate", "endDate", "companyName", "companyInfo", "title", "description", "location", "seniority", "isDecisionMaker", "employmentType", "jobFunction" ], "additionalProperties": false } }, "volunteer": { "type": "array", "items": { "type": "object", "properties": { "startDate": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "endDate": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "title": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "cause": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "organization": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "organizationId": { "anyOf": [ { "type": "object", "properties": { "linkedinId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "crunchbaseId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "facebookId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "twitterId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "linkedinId", "crunchbaseId", "facebookId", "twitterId" ], "additionalProperties": false }, { "type": "null" } ] }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "logoUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "startDate", "endDate", "title", "cause", "organization", "organizationId", "description", "logoUrl" ], "additionalProperties": false } } }, "required": [ "work", "volunteer" ], "additionalProperties": false }, "education": { "type": "array", "items": { "type": "object", "properties": { "startDate": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "endDate": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "fieldOfStudy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "degreeName": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "school": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "schoolId": { "anyOf": [ { "type": "object", "properties": { "linkedinId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "crunchbaseId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "facebookId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "twitterId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "linkedinId", "crunchbaseId", "facebookId", "twitterId" ], "additionalProperties": false }, { "type": "null" } ] }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "logoUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "grade": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "activities": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "startDate", "endDate", "fieldOfStudy", "degreeName", "school", "schoolId", "description", "logoUrl", "grade", "activities" ], "additionalProperties": false } }, "certifications": { "type": "array", "items": { "type": "object", "properties": { "startDate": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "endDate": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "name": { "type": "string" }, "licenseNumber": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "displaySource": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "authority": { "type": "string" }, "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "organizationId": { "anyOf": [ { "type": "object", "properties": { "linkedinId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "crunchbaseId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "facebookId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "twitterId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "linkedinId", "crunchbaseId", "facebookId", "twitterId" ], "additionalProperties": false }, { "type": "null" } ] }, "organizationUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "startDate", "endDate", "name", "licenseNumber", "displaySource", "authority", "url", "organizationId", "organizationUrl" ], "additionalProperties": false } }, "accomplishments": { "type": "object", "properties": { "organizations": { "type": "array", "items": { "type": "object", "properties": { "startDate": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "endDate": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "name": { "type": "string" }, "position": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "startDate", "endDate", "name", "position", "description" ], "additionalProperties": false } }, "honorsAwards": { "type": "array", "items": { "type": "object", "properties": { "title": { "type": "string" }, "issuer": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "issuedDate": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "title", "issuer", "issuedDate", "description" ], "additionalProperties": false } }, "courses": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "number": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "name", "number" ], "additionalProperties": false } }, "projects": { "type": "array", "items": { "type": "object", "properties": { "startDate": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "endDate": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "title": { "type": "string" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "startDate", "endDate", "title", "description", "url" ], "additionalProperties": false } }, "testScores": { "type": "array", "items": { "type": "object", "properties": { "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "score": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "date": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "name", "score", "date", "description" ], "additionalProperties": false } } }, "required": [ "organizations", "honorsAwards", "courses", "projects", "testScores" ], "additionalProperties": false }, "publications": { "type": "array", "items": { "type": "object", "properties": { "title": { "type": "string" }, "publisher": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "publishedDate": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "title", "publisher", "publishedDate", "description", "url" ], "additionalProperties": false } }, "patents": { "type": "array", "items": { "type": "object", "properties": { "title": { "type": "string" }, "issuer": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "issuedDate": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "applicationNumber": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "patentNumber": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "title", "issuer", "issuedDate", "description", "applicationNumber", "patentNumber", "url" ], "additionalProperties": false } }, "contactInformation": { "anyOf": [ { "type": "object", "properties": { "emails": { "description": "Only valid addresses are returned: consumer-provider addresses from the profile → personal, prospected addresses → work", "type": "object", "properties": { "personal": { "type": "array", "items": { "type": "object", "properties": { "email": { "type": "string" }, "normalized": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "validity": { "description": "Always \"valid\" — only valid addresses are returned", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "validatedAt": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "gateway": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "email", "normalized", "validity", "validatedAt", "gateway" ], "additionalProperties": false } }, "work": { "type": "array", "items": { "type": "object", "properties": { "email": { "type": "string" }, "normalized": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "validity": { "description": "Always \"valid\" — only valid addresses are returned", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "validatedAt": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "gateway": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "email", "normalized", "validity", "validatedAt", "gateway" ], "additionalProperties": false } } }, "required": [ "personal", "work" ], "additionalProperties": false }, "phoneNumbers": { "anyOf": [ { "type": "array", "items": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, { "type": "null" } ] }, "socialLinks": { "anyOf": [ { "type": "object", "properties": { "linkedinUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "githubUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "facebookUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "twitterUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "websiteUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "linkedinUrl", "githubUrl", "facebookUrl", "twitterUrl", "websiteUrl" ], "additionalProperties": false }, { "type": "null" } ] } }, "required": [ "emails", "phoneNumbers", "socialLinks" ], "additionalProperties": false }, { "type": "null" } ] }, "languages": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "proficiency": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "name", "proficiency" ], "additionalProperties": false } }, "interests": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] }, "inferredGender": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "industries": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] }, "socialPresence": { "type": "object", "properties": { "followers": { "type": "object", "properties": { "total": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "linkedin": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "twitter": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "facebook": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "github": { "anyOf": [ { "type": "number" }, { "type": "null" } ] } }, "required": [ "total", "linkedin", "twitter", "facebook", "github" ], "additionalProperties": false }, "followersCountTimeseries": { "type": "array", "items": { "type": "object", "properties": { "date": { "type": "string" }, "value": { "anyOf": [ { "type": "number" }, { "type": "string" } ] } }, "required": [ "date", "value" ], "additionalProperties": false } }, "connections": { "type": "object", "properties": { "total": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "linkedin": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "twitter": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "facebook": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "github": { "anyOf": [ { "type": "number" }, { "type": "null" } ] } }, "required": [ "total", "linkedin", "twitter", "facebook", "github" ], "additionalProperties": false } }, "required": [ "followers", "followersCountTimeseries", "connections" ], "additionalProperties": false }, "relatedProfiles": { "type": "array", "items": { "type": "object", "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "headline": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "location": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "url", "name", "headline", "location" ], "additionalProperties": false } }, "recommendations": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] }, "activities": { "type": "array", "items": { "type": "object", "properties": { "title": { "type": "string" }, "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "title", "url" ], "additionalProperties": false } }, "similarNames": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "url": { "type": "string" }, "headline": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "location": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "name", "url", "headline", "location" ], "additionalProperties": false } }, "articles": { "type": "array", "items": { "type": "object", "properties": { "title": { "type": "string" }, "url": { "type": "string" }, "publishedDate": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "author": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "imageUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "title", "url", "publishedDate", "author", "imageUrl" ], "additionalProperties": false } }, "groups": { "type": "array", "items": { "type": "object", "properties": { "id": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "link": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "type": { "type": "string", "const": "LinkedIn Group" } }, "required": [ "id", "name", "link", "type" ], "additionalProperties": false } }, "developerProfile": { "anyOf": [ { "type": "object", "properties": { "github": { "type": "object", "properties": { "username": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "avatarUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "followersCount": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "followingCount": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "publicReposCount": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "publicGistsCount": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "languages": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] }, "contributionsCount": { "anyOf": [ { "type": "number" }, { "type": "null" } ] } }, "required": [ "username", "avatarUrl", "followersCount", "followingCount", "publicReposCount", "publicGistsCount", "languages", "contributionsCount" ], "additionalProperties": false } }, "required": [ "github" ], "additionalProperties": false }, { "type": "null" } ] }, "careerInsight": { "anyOf": [ { "type": "object", "properties": { "estimatedSalary": { "anyOf": [ { "type": "object", "properties": { "min": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "max": { "anyOf": [ { "type": "number" }, { "type": "null" } ] } }, "required": [ "min", "max" ], "additionalProperties": false }, { "type": "null" } ] }, "seniority": { "anyOf": [ { "type": "object", "properties": { "totalExperienceYears": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "currentTenureYears": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "averageTenureYears": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "isInfluencer": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] } }, "required": [ "totalExperienceYears", "currentTenureYears", "averageTenureYears", "isInfluencer" ], "additionalProperties": false }, { "type": "null" } ] }, "inferredSkills": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] } }, "required": [ "estimatedSalary", "seniority", "inferredSkills" ], "additionalProperties": false }, { "type": "null" } ] }, "meta": { "type": "object", "properties": { "updatedAt": { "type": "string" }, "activityAt": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "updatedAt", "activityAt" ], "additionalProperties": false } }, "required": [ "summary", "slug", "profileImageUrl", "backgroundImageUrl", "firstName", "lastName", "fullName", "middleName", "nickname", "suffix", "headline", "headlineTimeseries", "jobTitle", "about", "location", "experience", "education", "certifications", "accomplishments", "publications", "patents", "contactInformation", "languages", "interests", "inferredGender", "industries", "socialPresence", "relatedProfiles", "recommendations", "activities", "similarNames", "articles", "groups", "developerProfile", "careerInsight", "meta" ], "additionalProperties": false } } } }, "400": { "description": "Invalid parameters provided. Refer to the documentation and message body for more info", "headers": { "X-Request-Id": { "$ref": "#/components/headers/X-Request-Id" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "example": { "code": 400, "name": "Bad Request", "description": "Invalid parameters provided. Refer to the documentation and message body for more info" } } } }, "401": { "description": "Invalid API key", "headers": { "X-Request-Id": { "$ref": "#/components/headers/X-Request-Id" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "example": { "code": 401, "name": "Unauthorized", "description": "Invalid API key" } } } }, "403": { "description": "You have run out of credits", "headers": { "X-Request-Id": { "$ref": "#/components/headers/X-Request-Id" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "example": { "code": 403, "name": "Forbidden", "description": "You have run out of credits" } } } }, "404": { "description": "The requested resource could not be found", "headers": { "X-Request-Id": { "$ref": "#/components/headers/X-Request-Id" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "example": { "code": 404, "name": "Not Found", "description": "The requested resource (e.g: user profile, company) could not be found" } } } }, "409": { "description": "A fresh profile could not be fetched; a cached profile exists but is older than the requested maxAgeSeconds. Retry the request, or raise maxAgeSeconds to accept the cached profile.", "headers": { "X-Request-Id": { "$ref": "#/components/headers/X-Request-Id" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FreshnessConflictError" }, "example": { "code": 409, "name": "Conflict", "description": "A fresh profile could not be fetched; a cached profile exists but is older than the requested maxAgeSeconds. Retry the request, or raise maxAgeSeconds to accept the cached profile.", "cachedProfileAgeSeconds": 5184000 } } } }, "429": { "description": "Rate limited. Please retry", "headers": { "X-Request-Id": { "$ref": "#/components/headers/X-Request-Id" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "example": { "code": 429, "name": "Too Many Requests", "description": "Rate limited. Please retry" } } } }, "500": { "description": "Internal Server Error", "headers": { "X-Request-Id": { "$ref": "#/components/headers/X-Request-Id" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "example": { "code": 500, "name": "Internal Server Error", "description": "Internal Server Error" } } } }, "503": { "description": "Retrieval failed, please retry.", "headers": { "X-Request-Id": { "$ref": "#/components/headers/X-Request-Id" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "example": { "code": 503, "name": "Service Unavailable", "description": "Retrieval failed, please retry." } } } } } } }, "/v3/company/logo": { "get": { "operationId": "getCompanyLogoV3", "summary": "Company Logo Endpoint", "description": "Search companies by name or domain and get matches with logo URLs", "tags": [ "company" ], "parameters": [ { "name": "q", "in": "query", "required": true, "description": "Company name or domain to search for", "schema": { "type": "string", "minLength": 1 } } ], "responses": { "200": { "description": "Matching companies with logo URLs", "headers": { "X-Request-Id": { "$ref": "#/components/headers/X-Request-Id" } }, "content": { "application/json": { "schema": { "description": "Matching companies, best match first", "type": "array", "items": { "type": "object", "properties": { "companyName": { "description": "Display name of the company", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "logoUrl": { "description": "Logo image URL", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "domain": { "description": "Resolved primary domain with the original and alternatives", "type": "object", "properties": { "resolved": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "original": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "alternatives": { "type": "array", "items": { "type": "string" } } }, "required": [ "resolved", "original", "alternatives" ], "additionalProperties": false }, "industry": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "employeeCount": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "location": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "linkedinUrl": { "description": "LinkedIn company profile URL", "type": "string" } }, "required": [ "companyName", "logoUrl", "domain", "industry", "employeeCount", "location", "linkedinUrl" ], "additionalProperties": false } } } } }, "400": { "description": "Invalid parameters provided. Refer to the documentation and message body for more info", "headers": { "X-Request-Id": { "$ref": "#/components/headers/X-Request-Id" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "example": { "code": 400, "name": "Bad Request", "description": "Invalid parameters provided. Refer to the documentation and message body for more info" } } } }, "401": { "description": "Invalid API key", "headers": { "X-Request-Id": { "$ref": "#/components/headers/X-Request-Id" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "example": { "code": 401, "name": "Unauthorized", "description": "Invalid API key" } } } }, "403": { "description": "You have run out of credits", "headers": { "X-Request-Id": { "$ref": "#/components/headers/X-Request-Id" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "example": { "code": 403, "name": "Forbidden", "description": "You have run out of credits" } } } }, "429": { "description": "Rate limited. Please retry", "headers": { "X-Request-Id": { "$ref": "#/components/headers/X-Request-Id" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "example": { "code": 429, "name": "Too Many Requests", "description": "Rate limited. Please retry" } } } }, "500": { "description": "Internal Server Error", "headers": { "X-Request-Id": { "$ref": "#/components/headers/X-Request-Id" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "example": { "code": 500, "name": "Internal Server Error", "description": "Internal Server Error" } } } }, "503": { "description": "Retrieval failed, please retry.", "headers": { "X-Request-Id": { "$ref": "#/components/headers/X-Request-Id" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "example": { "code": 503, "name": "Service Unavailable", "description": "Retrieval failed, please retry." } } } } } } } }, "components": { "securitySchemes": { "BearerAuth": { "type": "http", "scheme": "bearer", "description": "Enrich Layer API key, sent as `Authorization: Bearer `" } }, "schemas": { "Error": { "type": "object", "description": "Error returned for 4xx/5xx responses", "properties": { "code": { "type": "integer", "description": "HTTP status code" }, "name": { "type": "string", "description": "HTTP status reason phrase, e.g. \"Unauthorized\"" }, "description": { "type": "string", "description": "Human-readable detail" } }, "required": [ "code", "name", "description" ] }, "FreshnessConflictError": { "type": "object", "description": "Error returned for 409 responses", "properties": { "code": { "type": "integer", "description": "HTTP status code" }, "name": { "type": "string", "description": "HTTP status reason phrase, e.g. \"Conflict\"" }, "description": { "type": "string", "description": "Human-readable detail" }, "cachedProfileAgeSeconds": { "type": "integer", "description": "Age of the freshest cached profile available, in seconds" } }, "required": [ "code", "name", "description", "cachedProfileAgeSeconds" ] } }, "headers": { "X-Request-Id": { "description": "Identifier of this request. Include it when reporting issues", "schema": { "type": "string" } } } } }