{ "openapi": "3.1.0", "info": { "title": "Swarm API", "version": "1.0.0", "contact": { "name": "The Swarm", "url": "https://theswarm.com", "email": "hello@theswarm.com" } }, "servers": [ { "url": "https://bee.theswarm.com" } ], "security": [ { "ApiKeyAuth": [] } ], "tags": [ { "name": "profiles", "description": "Operations related to profiles" }, { "name": "companies", "description": "Operations related to companies" }, { "name": "teams", "description": "Operations for managing teams and connectors" }, { "name": "social", "description": "Operations related to social media posts and interactions" }, { "name": "mcp", "description": "Model Context Protocol endpoint for AI assistant integrations" }, { "name": "credits", "description": "Operations related to credit usage" }, { "name": "network-mapper", "description": "Operations for mapping connections and relationships across your network" } ], "paths": { "/v2/profiles/search": { "post": { "summary": "Search for profiles ids", "description": "Search for profiles ids using the [ElasticSearch Query DSL](https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl.html) format", "operationId": "searchProfiles", "security": [ { "ApiKeyAuth": [] } ], "tags": [ "profiles" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "query": { "type": "object", "description": "Search query in the [ElasticSearch Query DSL](https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl.html) format. [Find mapping here](https://docs.theswarm.com/docs/mappings/profile-v2)", "example": { "match": { "profile_info.job_title": { "query": "Data Scientist" } } } }, "limit": { "type": "integer", "description": "Limit the number of results. If you want to use stable_pagination this parameter must be set to 1000", "default": 100, "maximum": 1000 }, "paginationToken": { "type": "string", "description": "Pagination token received in the previous response" }, "stable_pagination": { "type": "boolean", "description": "When set to true, ensures that pagination results remain consistent, even if the underlying data changes during retrieval. This is useful for retrieving large result sets reliably across multiple requests", "default": false }, "inNetworkOnly": { "type": "boolean", "description": "When set to true, restricts search results to profiles that are connected to your team's network. This parameter filters the query to only return profiles that have established connections with connectors of your organization.", "default": false } }, "required": [ "query" ] } } } }, "responses": { "200": { "description": "A list of profile ids matching provided query", "content": { "application/json": { "schema": { "type": "object", "properties": { "ids": { "description": "List of profile ids", "type": "array", "items": { "type": "string", "format": "uuid" } }, "totalCount": { "description": "Total number of profiles matching the query", "type": "integer" }, "paginationToken": { "description": "Pagination token for the next request", "type": "string" } }, "required": [ "ids", "totalCount" ] } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "5XX": { "$ref": "#/components/responses/5XX" } } } }, "/v2/profiles/fetch": { "post": { "summary": "Fetch profiles with corresponding data", "description": "Fetch profiles with corresponding data (e.g. connections, lists, tags)", "operationId": "fetchProfiles", "security": [ { "ApiKeyAuth": [] } ], "tags": [ "profiles" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "The Swarm profile IDs" }, "linkedinNames": { "type": "array", "items": { "type": "string" }, "description": "LinkedIn profile URL slugs" }, "linkedinIds": { "type": "array", "items": { "type": "integer" }, "description": "LinkedIn numeric profile IDs" }, "linkedinEntityIds": { "type": "array", "items": { "type": "string" }, "description": "LinkedIn alphanumeric entity IDs" }, "fields": { "type": "array", "items": { "type": "string", "enum": [ "profile_info", "connections", "tags", "lists", "notes", "investor_data" ] }, "minItems": 1, "default": [ "profile_info" ] } }, "anyOf": [ { "required": [ "ids" ] }, { "required": [ "linkedinNames" ] }, { "required": [ "linkedinIds" ] }, { "required": [ "linkedinEntityIds" ] } ] } } } }, "responses": { "200": { "description": "A list of profiles with corresponding data", "content": { "application/json": { "schema": { "type": "object", "properties": { "results": { "description": "List of profiles with corresponding data", "type": "array", "items": { "$ref": "#/components/schemas/Profile" } }, "notFound": { "description": "Identifiers (ids / linkedinNames / linkedinIds / linkedinEntityIds) not found", "type": "array", "items": { "type": "string" } } }, "required": [ "results" ] } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "5XX": { "$ref": "#/components/responses/5XX" } } } }, "/v2/profiles/network-mapper": { "post": { "summary": "Find connected profiles (network mapper)", "description": "Find connected profiles, with it's connection details", "operationId": "networkMapper", "security": [ { "ApiKeyAuth": [] } ], "tags": [ "network-mapper" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "query": { "type": "object", "description": "Search query in the [ElasticSearch Query DSL](https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl.html) format. [Find mapping here](https://docs.theswarm.com/docs/mappings/profile-v2)", "example": { "match": { "profile_info.job_title": { "query": "Data Scientist" } } } }, "mapping_company_website": { "type": "string", "description": "Website of the company to map network for (optional)" }, "callback_url": { "type": "string", "description": "URL to call when async mapping completes (optional)" } }, "required": [ "query" ] } } } }, "responses": { "200": { "description": "list of found profiles that are connected to your team, and match your query", "content": { "application/json": { "schema": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/NetworkMapperItem" } }, "count": { "type": "integer" }, "total_count": { "type": "integer" } }, "required": [ "items", "count", "total_count" ] } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "5XX": { "$ref": "#/components/responses/5XX" }, "202": { "description": "Mapping task started; poll /v2/profiles/network-mapper-task-status with the returned task_id", "content": { "application/json": { "schema": { "type": "object", "properties": { "task_id": { "type": "string", "description": "Task ID to poll for results" } }, "required": [ "task_id" ] } } } } } } }, "/companies/search": { "post": { "summary": "Search for companies ids", "description": "Search for companies ids using the [ElasticSearch Query DSL](https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl.html) format", "operationId": "searchCompanies", "security": [ { "ApiKeyAuth": [] } ], "tags": [ "companies" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "query": { "type": "object", "description": "Search query in the [ElasticSearch Query DSL](https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl.html) format. [Find mapping here](https://docs.theswarm.com/docs/mappings/company-v2)", "example": { "match": { "company_info.industry": { "query": "Financial Services" } } } }, "limit": { "type": "integer", "description": "Limit the number of results. If you want to use stable_pagination this parameter must be set to 1000", "default": 100, "maximum": 1000 }, "paginationToken": { "type": "string", "description": "Pagination token received in the previous response" }, "stable_pagination": { "type": "boolean", "description": "When set to true, ensures that pagination results remain consistent, even if the underlying data changes during retrieval. This is useful for retrieving large result sets reliably across multiple requests", "default": false } }, "required": [ "query" ] } } } }, "responses": { "200": { "description": "A list of profile ids matching provided query", "content": { "application/json": { "schema": { "type": "object", "properties": { "ids": { "description": "List of company ids", "type": "array", "items": { "type": "string", "format": "uuid" } }, "totalCount": { "description": "Total number of profiles matching the query", "type": "integer" }, "paginationToken": { "description": "Pagination token for the next request", "type": "string" } }, "required": [ "ids", "totalCount" ] } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "5XX": { "$ref": "#/components/responses/5XX" } } } }, "/companies/fetch": { "post": { "summary": "Fetch companies with corresponding data", "description": "Fetch companies with corresponding data (e.g. tags)", "operationId": "fetchCompanies", "security": [ { "ApiKeyAuth": [] } ], "tags": [ "companies" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "The Swarm company IDs" }, "linkedinNames": { "type": "array", "items": { "type": "string" }, "description": "LinkedIn company URL slugs" }, "linkedinIds": { "type": "array", "items": { "type": "integer" }, "description": "LinkedIn numeric company IDs" }, "fields": { "type": "array", "items": { "type": "string", "enum": [ "company_info", "tags" ] }, "minItems": 1, "default": [ "company_info" ] } }, "anyOf": [ { "required": [ "ids" ] }, { "required": [ "linkedinNames" ] }, { "required": [ "linkedinIds" ] } ] } } } }, "responses": { "200": { "description": "A list of companies with corresponding data", "content": { "application/json": { "schema": { "type": "object", "properties": { "results": { "description": "List of companies with corresponding data", "type": "array", "items": { "$ref": "#/components/schemas/Company" } }, "notFound": { "description": "List of company identifiers (ids / linkedinNames / linkedinIds) that were not found", "type": "array", "items": { "type": "string" } } }, "required": [ "results" ] } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "5XX": { "$ref": "#/components/responses/5XX" } } } }, "/team/add-connector": { "post": { "summary": "Add connector(s) to the team", "description": "Add one or more LinkedIn users as connectors to the team", "operationId": "addConnector", "security": [ { "ApiKeyAuth": [] } ], "tags": [ "teams" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "linkedin_usernames": { "type": "array", "items": { "type": "string" }, "description": "LinkedIn URL slugs of the users to add as connectors. Accepts both username-only slugs (e.g. `john-doe`) and full profile URLs (e.g. `https://linkedin.com/in/john-doe`)." }, "group": { "type": "string", "description": "Member group to assign to the connector", "enum": [ "others", "employees", "investors", "customers", "portfolio", "advisors" ] } }, "required": [ "linkedin_usernames" ] } } } }, "responses": { "200": { "description": "Request processed; no connectors were queued (all slugs resolved to existing members or none found)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AddConnectorResponse" } } } }, "202": { "description": "Connector addition accepted and being processed asynchronously", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AddConnectorResponse" } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "409": { "description": "Connector limit exceeded for the team" }, "5XX": { "$ref": "#/components/responses/5XX" } } } }, "/team/create-team": { "post": { "summary": "Create a child team", "description": "Create a new child team under the authenticated team", "operationId": "createTeam", "security": [ { "ApiKeyAuth": [] } ], "tags": [ "teams" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "team_name": { "type": "string", "description": "Name of the new team" }, "owner_email": { "type": "string", "description": "Email of the team owner. If omitted, the current team's owner is used." }, "company_website": { "type": "string", "description": "Company website to use for automatic network mapping. Cannot be combined with company_linkedin_url." }, "company_linkedin_url": { "type": "string", "description": "Company LinkedIn URL to use for automatic network mapping. Cannot be combined with company_website." } }, "required": [ "team_name" ] } } } }, "responses": { "200": { "description": "Team created successfully", "content": { "application/json": { "schema": { "type": "object", "properties": { "team_id": { "type": "string", "format": "uuid", "description": "ID of the newly created team" } }, "required": [ "team_id" ] } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "404": { "description": "Team owner not found" }, "409": { "description": "Team name already exists" }, "5XX": { "$ref": "#/components/responses/5XX" } } } }, "/social/profile/posts": { "get": { "summary": "Get profile posts", "description": "Fetch LinkedIn posts published by a person", "operationId": "getProfilePosts", "security": [ { "ApiKeyAuth": [] } ], "tags": [ "social" ], "parameters": [ { "name": "linkedinID", "in": "query", "description": "LinkedIn URL slug of the person", "schema": { "type": "string" } }, { "name": "linkedinName", "in": "query", "description": "LinkedIn URL slug of the person", "schema": { "type": "string" } }, { "name": "linkedinEntityID", "in": "query", "description": "LinkedIn alphanumeric entity ID of the person", "schema": { "type": "string" } }, { "name": "perPage", "in": "query", "description": "Number of posts to return (max 100)", "schema": { "type": "integer", "minimum": 0, "maximum": 100 } }, { "name": "paginationToken", "in": "query", "description": "Pagination token from the previous response", "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of posts", "content": { "application/json": { "schema": { "type": "object", "properties": { "posts": { "type": "array", "items": { "$ref": "#/components/schemas/SocialPost" } }, "paginationToken": { "type": "string", "description": "Token to retrieve the next page of results" } }, "required": [ "posts" ] } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "5XX": { "$ref": "#/components/responses/5XX" } } } }, "/social/company/posts": { "get": { "summary": "Get company posts", "description": "Fetch LinkedIn posts published by a company", "operationId": "getCompanyPosts", "security": [ { "ApiKeyAuth": [] } ], "tags": [ "social" ], "parameters": [ { "name": "linkedinID", "in": "query", "description": "LinkedIn company URL slug", "schema": { "type": "string" } }, { "name": "linkedinName", "in": "query", "description": "LinkedIn company URL slug", "schema": { "type": "string" } }, { "name": "perPage", "in": "query", "description": "Number of posts per page", "schema": { "type": "integer" } }, { "name": "page", "in": "query", "description": "Page number (1-based)", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "List of company posts", "content": { "application/json": { "schema": { "type": "object", "properties": { "posts": { "type": "array", "items": { "$ref": "#/components/schemas/SocialPost" } }, "page": { "type": "integer" }, "pages": { "type": "integer" }, "totalResults": { "type": "integer" } }, "required": [ "posts" ] } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "5XX": { "$ref": "#/components/responses/5XX" } } } }, "/social/post/{urn}/reactions": { "get": { "summary": "Get post reactions", "description": "Fetch reactions on a LinkedIn post", "operationId": "getPostReactions", "security": [ { "ApiKeyAuth": [] } ], "tags": [ "social" ], "parameters": [ { "name": "urn", "in": "path", "required": true, "description": "LinkedIn post URN", "schema": { "type": "string" } }, { "name": "page", "in": "query", "required": false, "description": "Page number (1-indexed). Optional.", "schema": { "type": "integer", "minimum": 1, "default": 1 } }, { "name": "perPage", "in": "query", "required": false, "description": "Number of items per page. Max 100. Optional.", "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 10 } } ], "responses": { "200": { "description": "List of reactions", "content": { "application/json": { "schema": { "type": "object", "properties": { "results": { "type": "array", "items": { "$ref": "#/components/schemas/SocialReaction" } }, "pages": { "type": "integer" }, "totalResults": { "type": "integer" } }, "required": [ "results" ] } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "5XX": { "$ref": "#/components/responses/5XX" } } } }, "/social/post/{urn}/reshares": { "get": { "summary": "Get post reshares", "description": "Fetch reshares of a LinkedIn post", "operationId": "getPostReshares", "security": [ { "ApiKeyAuth": [] } ], "tags": [ "social" ], "parameters": [ { "name": "urn", "in": "path", "required": true, "description": "LinkedIn post URN", "schema": { "type": "string" } }, { "name": "page", "in": "query", "required": false, "description": "Page number (1-indexed). Optional.", "schema": { "type": "integer", "minimum": 1, "default": 1 } }, { "name": "perPage", "in": "query", "required": false, "description": "Number of items per page. Max 100. Optional.", "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 10 } } ], "responses": { "200": { "description": "List of reshared posts", "content": { "application/json": { "schema": { "type": "object", "properties": { "posts": { "type": "array", "items": { "$ref": "#/components/schemas/SocialPost" } }, "total_count": { "type": "integer" }, "pages": { "type": "integer" }, "pagination_token": { "type": "string" } }, "required": [ "posts" ] } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "5XX": { "$ref": "#/components/responses/5XX" } } } }, "/social/post/{urn}/comments": { "get": { "summary": "Get post comments", "description": "Fetch comments on a LinkedIn post", "operationId": "getPostComments", "security": [ { "ApiKeyAuth": [] } ], "tags": [ "social" ], "parameters": [ { "name": "urn", "in": "path", "required": true, "description": "LinkedIn post URN", "schema": { "type": "string" } }, { "name": "page", "in": "query", "required": false, "description": "Page number (1-indexed). Optional.", "schema": { "type": "integer", "minimum": 1, "default": 1 } }, { "name": "perPage", "in": "query", "required": false, "description": "Number of items per page. Max 100. Optional.", "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 10 } } ], "responses": { "200": { "description": "List of comments", "content": { "application/json": { "schema": { "type": "object", "properties": { "comments": { "type": "array", "items": { "$ref": "#/components/schemas/SocialComment" } }, "totalCount": { "type": "integer" }, "pages": { "type": "integer" }, "paginationToken": { "type": "string" } }, "required": [ "comments" ] } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "5XX": { "$ref": "#/components/responses/5XX" } } } }, "/v2/profiles/fetch/refresh": { "get": { "summary": "Fetch a refreshed profile", "description": "Fetch up-to-date profile data for a given LinkedIn URL slug", "operationId": "getRefreshedProfile", "security": [ { "ApiKeyAuth": [] } ], "tags": [ "profiles" ], "parameters": [ { "name": "linkedinName", "in": "query", "required": true, "description": "LinkedIn URL slug of the profile", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Refreshed profile data", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProfileInfo" } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "404": { "description": "Profile not found" }, "5XX": { "$ref": "#/components/responses/5XX" } } } }, "/v2/profiles/network-mapper-task-status": { "post": { "summary": "Get network mapper task status", "description": "Check the status of a network mapper task started by POST /v2/profiles/network-mapper", "operationId": "networkMapperTaskStatus", "security": [ { "ApiKeyAuth": [] } ], "tags": [ "network-mapper" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "task_id": { "type": "string", "description": "Task ID returned from POST /v2/profiles/network-mapper" } }, "required": [ "task_id" ] } } } }, "responses": { "200": { "description": "Task status", "content": { "application/json": { "schema": { "type": "object", "properties": { "task_status": { "type": "string", "description": "Current status of the network mapper task", "enum": [ "unknown", "in_progress", "done", "failed", "not_found" ] } }, "required": [ "task_status" ] } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "404": { "description": "Task not found" }, "5XX": { "$ref": "#/components/responses/5XX" } } } }, "/v2/network-mapper/partner/network": { "post": { "summary": "Trigger partner network mapping", "description": "Initiate network mapping for a given company. Returns data immediately if already mapped, or returns a task ID to poll for results.", "operationId": "postPartnerNetwork", "security": [ { "ApiKeyAuth": [] } ], "tags": [ "network-mapper" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "query": { "type": "object", "description": "Search query in the [ElasticSearch Query DSL](https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl.html) format. [Find mapping here](https://docs.theswarm.com/docs/mappings/profile-v2)" }, "mapping_company_website": { "type": "string", "description": "Website of the company to map network for" }, "callback_url": { "type": "string", "description": "URL to call when async mapping completes" } }, "required": [ "query", "mapping_company_website" ] } } } }, "responses": { "200": { "description": "Mapping data returned immediately", "content": { "application/json": { "schema": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/NetworkMapperItem" } }, "count": { "type": "integer" }, "total_count": { "type": "integer" } }, "required": [ "items", "count", "total_count" ] } } } }, "202": { "description": "Mapping task started; poll /v2/network-mapper/partner/network/status with the returned task_id", "content": { "application/json": { "schema": { "type": "object", "properties": { "task_id": { "type": "string", "description": "Task ID to poll for results" } }, "required": [ "task_id" ] } } } }, "404": { "description": "Company not found for the given mapping_company_website" }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "5XX": { "$ref": "#/components/responses/5XX" } } } }, "/mcp": { "post": { "summary": "MCP endpoint", "description": "Model Context Protocol (MCP) endpoint for AI assistant integrations", "operationId": "mcp", "security": [ { "ApiKeyAuth": [] } ], "tags": [ "mcp" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "description": "MCP protocol request body" } } } }, "responses": { "200": { "description": "MCP protocol response" }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "5XX": { "$ref": "#/components/responses/5XX" } } } }, "/v2/network-mapper/partner/network/status": { "get": { "summary": "Get partner network mapping status", "description": "Check the status of an async partner network mapping task", "operationId": "getPartnerNetworkStatus", "security": [ { "ApiKeyAuth": [] } ], "tags": [ "network-mapper" ], "parameters": [ { "name": "task_id", "in": "query", "required": true, "description": "Task ID returned from POST /v2/network-mapper/partner/network", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Current status of the mapping task", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "description": "Status of the network mapping task", "enum": [ "Unknown", "MappingFailed", "NotMapped", "MappingInProgress", "Mapped" ] } }, "required": [ "status" ] } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "5XX": { "$ref": "#/components/responses/5XX" } } } }, "/v3/profiles/search": { "post": { "summary": "Search for profiles ids", "description": "Search for profiles ids using the [ElasticSearch Query DSL](https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl.html) format", "operationId": "searchProfilesV3", "security": [ { "ApiKeyAuth": [] } ], "tags": [ "profiles" ], "parameters": [ { "$ref": "#/components/parameters/AuthenticateTeamHeader" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "query": { "type": "object", "description": "Search query in the [ElasticSearch Query DSL](https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl.html) format. [Find mapping here](https://docs.theswarm.com/docs/mappings/profile-v2)", "example": { "match": { "profile_info.job_title": { "query": "Data Scientist" } } } }, "limit": { "type": "integer", "description": "Limit the number of results. If you want to use stable_pagination this parameter must be set to 1000", "default": 100, "minimum": 0, "maximum": 1000 }, "pagination_token": { "type": "string", "description": "Pagination token received in the previous response" }, "stable_pagination": { "type": "boolean", "description": "When set to true, ensures that pagination results remain consistent, even if the underlying data changes during retrieval. This is useful for retrieving large result sets reliably across multiple requests", "default": false }, "in_network_only": { "type": "boolean", "description": "When set to true, restricts search results to profiles that are connected to your team's network. This parameter filters the query to only return profiles that have established connections with connectors of your organization.", "default": false } }, "required": [ "query" ] } } } }, "responses": { "200": { "description": "A list of profile ids matching provided query", "content": { "application/json": { "schema": { "type": "object", "properties": { "ids": { "description": "List of profile ids", "type": "array", "items": { "type": "string", "format": "uuid" } }, "total_count": { "description": "Total number of profiles matching the query", "type": "integer" }, "pagination_token": { "description": "Pagination token for the next request", "type": "string" } }, "required": [ "ids", "total_count" ] } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "5XX": { "$ref": "#/components/responses/5XX" } } } }, "/v3/profiles/fetch": { "post": { "summary": "Fetch profiles with corresponding data", "description": "Fetch profiles with corresponding data (e.g. lists, tags)", "operationId": "fetchProfilesV3", "parameters": [ { "$ref": "#/components/parameters/AuthenticateTeamHeader" } ], "security": [ { "ApiKeyAuth": [] } ], "tags": [ "profiles" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string", "format": "uuid" }, "maxItems": 1000, "description": "The Swarm profile IDs" }, "linkedin_names": { "type": "array", "items": { "type": "string" }, "maxItems": 1000, "description": "LinkedIn profile URL slugs" }, "linkedin_ids": { "type": "array", "items": { "type": "integer" }, "maxItems": 1000, "description": "LinkedIn numeric profile IDs" }, "linkedin_entity_ids": { "type": "array", "items": { "type": "string" }, "maxItems": 1000, "description": "LinkedIn alphanumeric entity IDs" }, "fields": { "type": "array", "items": { "type": "string", "enum": [ "profile_info", "tags", "lists" ] }, "default": [ "profile_info" ] } }, "anyOf": [ { "required": [ "ids" ] }, { "required": [ "linkedin_names" ] }, { "required": [ "linkedin_ids" ] }, { "required": [ "linkedin_entity_ids" ] } ] } } } }, "responses": { "200": { "description": "A list of profiles with corresponding data", "content": { "application/json": { "schema": { "type": "object", "properties": { "results": { "description": "List of profiles with corresponding data", "type": "array", "items": { "$ref": "#/components/schemas/ProfileV3" } }, "not_found": { "description": "Identifiers (ids / linkedin_names / linkedin_ids / linkedin_entity_ids) not found", "type": "array", "items": { "type": "string" } } }, "required": [ "results" ] } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "402": { "$ref": "#/components/responses/402" }, "403": { "$ref": "#/components/responses/403" }, "5XX": { "$ref": "#/components/responses/5XX" } } } }, "/v3/companies/search": { "post": { "summary": "Search for companies ids", "description": "Search for companies ids using the [ElasticSearch Query DSL](https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl.html) format", "operationId": "searchCompaniesV3", "parameters": [ { "$ref": "#/components/parameters/AuthenticateTeamHeader" } ], "security": [ { "ApiKeyAuth": [] } ], "tags": [ "companies" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "query": { "type": "object", "description": "Search query in the [ElasticSearch Query DSL](https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl.html) format. [Find mapping here](https://docs.theswarm.com/docs/mappings/company-v2)", "example": { "match": { "company_info.industry": { "query": "Financial Services" } } } }, "limit": { "type": "integer", "description": "Limit the number of results. If you want to use stable_pagination this parameter must be set to 1000", "default": 100, "minimum": 0, "maximum": 1000 }, "pagination_token": { "type": "string", "description": "Pagination token received in the previous response" }, "stable_pagination": { "type": "boolean", "description": "When set to true, ensures that pagination results remain consistent, even if the underlying data changes during retrieval. This is useful for retrieving large result sets reliably across multiple requests", "default": false } }, "required": [ "query" ] } } } }, "responses": { "200": { "description": "A list of company ids matching provided query", "content": { "application/json": { "schema": { "type": "object", "properties": { "ids": { "description": "List of company ids", "type": "array", "items": { "type": "string", "format": "uuid" } }, "total_count": { "description": "Total number of companies matching the query", "type": "integer" }, "pagination_token": { "description": "Pagination token for the next request", "type": "string" } }, "required": [ "ids", "total_count" ] } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "5XX": { "$ref": "#/components/responses/5XX" } } } }, "/v3/companies/fetch": { "post": { "summary": "Fetch companies with corresponding data", "description": "Fetch companies with corresponding data (e.g. tags)", "operationId": "fetchCompaniesV3", "parameters": [ { "$ref": "#/components/parameters/AuthenticateTeamHeader" } ], "security": [ { "ApiKeyAuth": [] } ], "tags": [ "companies" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string", "format": "uuid" }, "maxItems": 1000, "description": "The Swarm company IDs" }, "linkedin_names": { "type": "array", "items": { "type": "string" }, "maxItems": 1000, "description": "LinkedIn company URL slugs" }, "linkedin_ids": { "type": "array", "items": { "type": "integer" }, "maxItems": 1000, "description": "LinkedIn numeric company IDs" }, "fields": { "type": "array", "items": { "type": "string", "enum": [ "company_info", "tags" ] }, "default": [ "company_info" ] } }, "anyOf": [ { "required": [ "ids" ] }, { "required": [ "linkedin_names" ] }, { "required": [ "linkedin_ids" ] } ] } } } }, "responses": { "200": { "description": "A list of companies with corresponding data", "content": { "application/json": { "schema": { "type": "object", "properties": { "results": { "description": "List of companies with corresponding data", "type": "array", "items": { "$ref": "#/components/schemas/CompanyV3" } }, "not_found": { "description": "List of company identifiers (ids / linkedin_names / linkedin_ids) that were not found", "type": "array", "items": { "type": "string" } } }, "required": [ "results" ] } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "402": { "$ref": "#/components/responses/402" }, "403": { "$ref": "#/components/responses/403" }, "5XX": { "$ref": "#/components/responses/5XX" } } } }, "/v3/relationships": { "post": { "summary": "Relationships", "description": "Find connected profiles with their connection details. Renamed from Network Mapper in v3.", "operationId": "relationshipsV3", "parameters": [ { "$ref": "#/components/parameters/AuthenticateTeamHeader" } ], "security": [ { "ApiKeyAuth": [] } ], "tags": [ "network-mapper" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "query": { "type": "object", "description": "Search query in the [ElasticSearch Query DSL](https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl.html) format. [Find mapping here](https://docs.theswarm.com/docs/mappings/profile-v2)", "example": { "match": { "profile_info.job_title": { "query": "Data Scientist" } } } }, "limit": { "type": "integer", "description": "Limit the number of results", "default": 100, "minimum": 0, "maximum": 1000 }, "pagination_token": { "type": "string", "description": "Pagination token received in the previous response" } }, "required": [ "query" ] } } } }, "responses": { "200": { "description": "list of found profiles that are connected to your team, and match your query", "content": { "application/json": { "schema": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/NetworkMapperItem" } }, "count": { "type": "integer" }, "total_count": { "type": "integer" }, "pagination_token": { "description": "Pagination token for the next request", "type": "string" } }, "required": [ "items", "count", "total_count" ] } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "5XX": { "$ref": "#/components/responses/5XX" } } } }, "/v3/network-mapper": { "post": { "summary": "Network Mapper (Partner) \u2014 v3", "description": "Partner-permission endpoint for mapping connections across the partner network. Calls from API keys not tied to a team with the partner permission in Stripe return 403 Forbidden. Costs 1 credit per non-empty response.", "operationId": "postPartnerNetworkV3", "security": [ { "ApiKeyAuth": [] } ], "tags": [ "network-mapper" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "query": { "type": "object", "description": "Search query in the [ElasticSearch Query DSL](https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl.html) format. [Find mapping here](https://docs.theswarm.com/docs/mappings/profile-v2)" }, "mapping_company_website": { "type": "string", "description": "Website of the company to map network for" }, "callback_url": { "type": "string", "description": "URL to call when async mapping completes" } }, "required": [ "query", "mapping_company_website" ] } } } }, "responses": { "200": { "description": "Mapping data returned immediately", "content": { "application/json": { "schema": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/NetworkMapperItem" } }, "count": { "type": "integer" }, "total_count": { "type": "integer" } }, "required": [ "items", "count", "total_count" ] } } } }, "202": { "description": "Mapping task started; poll /v3/network-mapper/status with the returned task_id", "content": { "application/json": { "schema": { "type": "object", "properties": { "task_id": { "type": "string", "description": "Task ID to poll for results" } }, "required": [ "task_id" ] } } } }, "404": { "description": "Company not found for the given mapping_company_website" }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "402": { "$ref": "#/components/responses/402" }, "403": { "description": "Forbidden \u2014 the API key is not tied to a team with partner permission." }, "5XX": { "$ref": "#/components/responses/5XX" } } } }, "/v3/network-mapper/status": { "get": { "summary": "Network Mapper (Partner) Status", "description": "Poll the status of a long-running Network Mapper (Partner) v3 task. Partner permission required.", "operationId": "getPartnerNetworkStatusV3", "security": [ { "ApiKeyAuth": [] } ], "tags": [ "network-mapper" ], "parameters": [ { "name": "task_id", "in": "query", "required": true, "description": "Task ID returned from POST /v3/network-mapper", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Current status of the mapping task", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "description": "Status of the network mapping task", "enum": [ "Unknown", "MappingFailed", "NotMapped", "MappingInProgress", "Mapped" ] } }, "required": [ "status" ] } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "403": { "description": "Forbidden \u2014 the API key is not tied to a team with partner permission." }, "5XX": { "$ref": "#/components/responses/5XX" } } } }, "/v2/profiles/aggregate": { "post": { "summary": "Aggregate profile field values", "description": "Return distinct values for a single profile field matching a text query (e.g. autocomplete for locations or current job titles).", "operationId": "aggregateProfiles", "security": [ { "ApiKeyAuth": [] } ], "tags": [ "profiles" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "query": { "type": "string", "description": "Text to match (minimum 3 characters)", "minLength": 3 }, "field": { "type": "string", "enum": [ "location", "currentJobTitle" ], "description": "Field to aggregate" } }, "required": [ "query", "field" ] } } } }, "responses": { "200": { "description": "Aggregated values", "content": { "application/json": { "schema": { "type": "object", "properties": { "field": { "type": "string", "description": "The aggregated field" }, "values": { "type": "array", "items": { "type": "string" }, "description": "Distinct values for the field" } }, "required": [ "field", "values" ] } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "5XX": { "$ref": "#/components/responses/5XX" } } } }, "/credits/usage": { "get": { "summary": "Get credits usage", "description": "Retrieve your team's current billing period credit usage. The API identifies your team from the API key, fetches the meter usage for the active billing period, and returns the number of credits already consumed.", "operationId": "getCreditsUsage", "security": [ { "ApiKeyAuth": [] } ], "tags": [ "credits" ], "parameters": [], "responses": { "200": { "description": "Current credit usage for the billing period", "content": { "application/json": { "schema": { "type": "object", "properties": { "usage": { "type": "integer", "description": "Number of credits already consumed in the current billing period", "example": 2255235 } }, "required": [ "usage" ] } } } }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "5XX": { "$ref": "#/components/responses/5XX" } } } } }, "components": { "schemas": { "ErrorResponse": { "type": "object", "properties": { "code": { "description": "Error status code", "type": "integer" }, "errors": { "type": "array", "items": { "type": [ "string", "object" ] } } }, "required": [ "code" ] }, "Profile": { "type": "object", "properties": { "id": { "type": "string", "description": "The unique identifier of the profile", "format": "uuid" }, "connections": { "type": "array", "items": { "$ref": "#/components/schemas/Connection" }, "description": "The connections of the profile" }, "lists": { "type": "array", "items": { "$ref": "#/components/schemas/Pipeline" }, "description": "The pipelines of the profile" }, "notes": { "type": "array", "items": { "$ref": "#/components/schemas/Note" }, "description": "The notes of the profile" }, "tags": { "type": "array", "items": { "$ref": "#/components/schemas/Tag" }, "description": "The tags of the profile" }, "profile_info": { "$ref": "#/components/schemas/ProfileInfo", "description": "The profile information" }, "found_by": { "$ref": "#/components/schemas/FoundBy" } }, "required": [ "id" ] }, "ProfileInfo": { "type": "object", "properties": { "id": { "type": "string", "description": "The unique identifier of the profile", "format": "uuid" }, "full_name": { "type": "string", "description": "The full name of the profile" }, "first_name": { "type": "string", "description": "The first name of the profile" }, "last_name": { "type": "string", "description": "The last name of the profile" }, "headline": { "type": "string", "description": "The title of the current job" }, "about": { "type": "string", "description": "The industry of the profile" }, "linkedin_url": { "type": "string", "description": "The LinkedIn URL of the profile" }, "work_email": { "type": "string", "description": "The work email of the profile" }, "personal_emails": { "type": "array", "items": { "type": "string" }, "description": "The personal emails of the profile" }, "current_title": { "type": "string", "description": "The title of the current job" }, "current_function": { "type": "string", "description": "The role of the title in the current job" }, "current_seniority": { "type": "array", "items": { "type": "string" }, "description": "The person's seniority in the current job" }, "current_company_id": { "type": "string", "description": "The unique identifier of the company in the current job", "format": "uuid" }, "current_company_name": { "type": "string", "description": "The name of the company in the current job" }, "current_company_logo_url": { "type": "string", "description": "The logo URL of the company in the current job" }, "current_company_website": { "type": "string", "description": "The website of the company in the current job" }, "current_company_size": { "$ref": "#/components/schemas/SizeClass" }, "current_company_industry": { "type": "string", "description": "The industry of the company in the current job" }, "current_company_location": { "type": "string", "description": "The location name of the company in the current job" }, "current_company_linkedin_url": { "type": "string", "description": "The LinkedIn URL of the company in the current job" }, "experience": { "type": "array", "items": { "$ref": "#/components/schemas/Job" }, "description": "The experience of the profile" }, "current_location": { "type": "string", "description": "The location name of the profile" }, "other_locations": { "type": "array", "items": { "type": "string" }, "description": "The location names of the profile" }, "skills": { "type": "array", "items": { "type": "string" }, "description": "The skills of the profile" }, "education": { "type": "array", "items": { "$ref": "#/components/schemas/Education" }, "description": "The education of the profile" }, "linkedin_experience_count": { "type": "integer", "description": "Total number of experience entries on LinkedIn" }, "linkedin_education_count": { "type": "integer", "description": "Total number of education entries on LinkedIn" }, "social_media": { "type": "array", "items": { "$ref": "#/components/schemas/SocialMedia" }, "description": "Social media profiles" }, "investor_data": { "$ref": "#/components/schemas/InvestorData", "description": "Investor-related data" }, "smart_tags": { "type": "array", "items": { "type": "string" }, "description": "AI-generated tags for the profile" }, "latest_role_change_at": { "type": "string", "format": "date", "description": "The date of the latest role change" }, "latest_company_change_at": { "type": "string", "format": "date", "description": "The date of the latest company change" }, "current_job_updated_at": { "type": "string", "format": "date-time", "description": "The update date of current job in the profile" }, "updated_at": { "type": "string", "format": "date-time", "description": "The update date of the profile" }, "created_at": { "type": "string", "format": "date-time", "description": "The creation date of the profile" }, "last_refresh_at": { "type": "string", "format": "date-time", "description": "The last refresh date of the profile" }, "current_company_websites": { "type": "array", "items": { "type": "string" }, "description": "The websites of the company in the current job" }, "current_company_industries": { "type": "array", "items": { "type": "string" }, "description": "The industries of the company in the current job" }, "certifications": { "type": "array", "items": { "$ref": "#/components/schemas/Certification" }, "description": "The certifications of the profile" }, "image_url": { "type": "string", "description": "Profile image URL (CDN)" } }, "required": [ "id" ] }, "Note": { "type": "object", "properties": { "id": { "type": "string", "description": "The unique identifier of the note" }, "content": { "type": "string", "description": "The content of the note" } }, "required": [ "id", "content" ] }, "Tag": { "type": "object", "properties": { "id": { "type": "string", "description": "The unique identifier of the tag" }, "name": { "type": "string", "description": "The name of the tag" } }, "required": [ "id", "name" ] }, "Pipeline": { "type": "object", "properties": { "id": { "type": "string", "description": "The unique identifier of the pipeline" }, "name": { "type": "string", "description": "The name of the pipeline" }, "status": { "type": "string", "description": "The status of the pipeline" } }, "required": [ "id", "name", "status" ] }, "Job": { "type": "object", "properties": { "is_current": { "type": "boolean", "description": "Whether the job is primary or not" }, "company_id": { "type": "string", "description": "The unique identifier of the company in the job", "format": "uuid" }, "company": { "$ref": "#/components/schemas/ProfileCompany" }, "title": { "type": "string", "description": "The title of the job" }, "seniority": { "type": "array", "items": { "type": "string" }, "description": "The person's seniority in the job" }, "function": { "type": "string", "description": "The role/function in the job" }, "location": { "type": "array", "items": { "type": "string" }, "description": "Job location names" }, "description": { "type": "string", "description": "The description of the job" }, "start_date": { "type": "string", "format": "date", "description": "The start date of the job" }, "end_date": { "type": "string", "format": "date", "description": "The end date of the job" }, "status": { "type": "string", "description": "Experience status enum", "enum": [ "unknown", "past", "ongoing" ] } } }, "Education": { "type": "object", "properties": { "school": { "$ref": "#/components/schemas/School" }, "start_date": { "type": "string", "format": "date", "description": "The start date of the education" }, "end_date": { "type": "string", "format": "date", "description": "The end date of the education" }, "degrees": { "type": "array", "items": { "type": "string" }, "description": "The degrees of the education" }, "majors": { "type": "array", "items": { "type": "string" }, "description": "The majors of the education" }, "minors": { "type": "array", "items": { "type": "string" }, "description": "The minors of the education" }, "activities": { "type": "string", "description": "The activities of the education" }, "grade": { "type": "string", "description": "The grade of the education" }, "description": { "type": "string", "description": "The description of the education" } } }, "School": { "type": "object", "properties": { "name": { "type": "string", "description": "The name of the school" }, "location": { "$ref": "#/components/schemas/Location" }, "website": { "type": "string", "description": "The website of the school" }, "linkedin_url": { "type": "string", "description": "Linkedin profile URL of the school" }, "linkedin_id": { "type": "string", "description": "Linkedin numeric id of the school" }, "social_media": { "type": "array", "items": { "$ref": "#/components/schemas/SocialMedia" }, "description": "Social media profiles of the school" } } }, "Location": { "type": "object", "properties": { "name": { "type": "string", "description": "The name of the location" }, "city": { "type": "string", "description": "The city of the location" }, "state": { "type": "string", "description": "The state of the location" }, "country": { "type": "string", "description": "The country of the location" }, "street_address": { "type": "string", "description": "The street address of the location" }, "postal_code": { "type": "string", "description": "The postal code of the location" } } }, "Connection": { "type": "object", "properties": { "user_id": { "type": "string", "description": "The unique identifier of the user", "format": "uuid" }, "user_email": { "type": "string", "description": "The email of the user" }, "user_linkedin_name": { "type": "string", "description": "The LinkedIn name of the user" }, "created_at": { "type": "string", "format": "date-time", "description": "The creation date of the connection" }, "sources": { "type": "array", "items": { "$ref": "#/components/schemas/Source" }, "description": "The sources of the connection" }, "connection_strength": { "type": "number", "format": "float", "description": "The strength of the connection" }, "manual_strength": { "type": "number", "format": "float", "description": "The manually set strength of the connection" }, "strength_normalized": { "type": "integer", "description": "The normalized strength of the connection" } }, "required": [ "user_id", "user_email", "user_linkedin_name", "created_at", "sources", "connection_strength", "strength_normalized" ] }, "InvestorData": { "type": "object", "properties": { "description": { "type": "string", "description": "Investor description" }, "type": { "type": "array", "items": { "type": "string" }, "description": "Types (e.g. Angel, VC)" }, "industry_focus": { "type": "array", "items": { "type": "string" }, "description": "Industries of focus" }, "stage_focus": { "type": "array", "items": { "type": "string" }, "description": "Investment stages of focus" }, "geo_focus": { "type": "array", "items": { "type": "string" }, "description": "Geographies of focus" }, "check_size": { "type": "array", "items": { "type": "string" }, "description": "Typical check sizes" }, "portfolio_companies": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "description": "Portfolio company id" } }, "required": [ "id" ] }, "description": "Portfolio companies" } } }, "ProfileCompany": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "description": "The unique identifier of the company" }, "canonical_name": { "type": "string", "description": "The canonical name of the company" }, "name": { "type": "string", "description": "The name of the company" }, "founded": { "type": "string", "format": "date-time", "description": "The founding date of the company" }, "industry": { "type": "string", "description": "The industry of the company" }, "website": { "type": "string", "description": "The website of the company" }, "size": { "$ref": "#/components/schemas/SizeClass" }, "social_media": { "type": "array", "items": { "$ref": "#/components/schemas/SocialMedia" }, "description": "The networks of the company" }, "locations": { "type": "array", "items": { "$ref": "#/components/schemas/CompanyLocation" }, "description": "The locations of the company" }, "industries": { "type": "array", "items": { "type": "string" }, "description": "The industries of the company" }, "websites": { "type": "array", "items": { "type": "string" }, "description": "The websites of the company" }, "workforce": { "type": "object", "properties": { "headcount": { "type": "integer", "description": "Current headcount" } } } } }, "Company": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "company_info": { "type": "object", "properties": { "id": { "type": "string" }, "linkedin_slugs": { "type": "array", "items": { "type": "string" } }, "name": { "type": "string" }, "alternative_names": { "type": "array", "items": { "type": "string" } }, "description": { "type": "string" }, "summary": { "type": "string" }, "contact_info": { "type": "object", "properties": { "email": { "type": "string" }, "phone": { "type": "string" }, "url": { "type": "string" } } }, "canonical_name": { "type": "string" }, "founded": { "type": "string", "format": "date-time" }, "industry": { "type": "string" }, "website": { "type": "string" }, "workforce": { "type": "array", "items": { "type": "object", "properties": { "headcount": { "type": "integer" }, "historical_headcount": { "type": "array", "items": { "type": "object", "properties": { "timestamp": { "type": "integer" }, "count": { "type": "integer" } } } }, "size_class": { "type": "string" } } } }, "tech_stack": { "type": "object", "properties": { "products": { "type": "array", "items": { "type": "string" } } } }, "business_data": { "type": "object", "properties": { "identifiers": { "type": "object", "properties": { "stock_ticker": { "type": "string" }, "duns_code": { "type": "string" }, "cage_code": { "type": "string" }, "naics_code": { "type": "string" } } }, "customer_types": { "type": "array", "items": { "type": "string" } }, "stock_exchange": { "type": "string" }, "is_acquired": { "type": "boolean" }, "is_exited": { "type": "boolean" }, "is_government": { "type": "boolean" }, "is_non_profit": { "type": "boolean" }, "is_shut_down": { "type": "boolean" }, "is_startup": { "type": "boolean" }, "is_stealth": { "type": "boolean" }, "ownership_status": { "type": "string" }, "ownership_status_detailed": { "type": "string" }, "patent_count": { "type": "integer" }, "financing_profile": { "type": "object", "properties": { "status": { "type": "string" }, "ipo_date": { "type": "string", "format": "date-time" }, "outstanding_shares": { "type": "number" }, "market_cap": { "type": "number" } } } } }, "social_media": { "type": "array", "items": { "$ref": "#/components/schemas/SocialMedia" }, "description": "The networks of the company" }, "locations": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "country": { "type": "string" }, "is_primary": { "type": "boolean" } } } }, "logo_url": { "type": "string" }, "type": { "type": "array", "items": { "type": "string" } }, "specialities": { "type": "array", "items": { "type": "string" } }, "investments": { "type": "array", "items": { "type": "string" } }, "geography_focus": { "type": "array", "items": { "type": "string" } }, "funding": { "type": "object", "properties": { "last_round": { "type": "object", "properties": { "last_round_type": { "type": "string" }, "last_round_amount_usd": { "type": "integer" }, "last_round_date": { "type": "string", "format": "date-time" }, "last_round_investors": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "kind": { "type": "string", "enum": [ "Unknown", "Profile", "Company" ], "description": "Investor kind" }, "name": { "type": "string" }, "crunchbase_id": { "type": "string" }, "crunchbase_slug": { "type": "string" } } } } } }, "rounds": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string" }, "amount_usd": { "type": "integer" }, "date": { "type": "string", "format": "date-time" }, "investors": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "kind": { "type": "string", "enum": [ "Unknown", "Profile", "Company" ], "description": "Investor kind" }, "name": { "type": "string" }, "crunchbase_id": { "type": "string" }, "crunchbase_slug": { "type": "string" } } } } } } }, "total_funding_amount_usd": { "type": "integer" } } }, "updated_at": { "type": "string", "format": "date-time" }, "data_updated_at": { "type": "string", "format": "date-time" }, "industries": { "type": "array", "items": { "type": "string" } }, "websites": { "type": "array", "items": { "type": "string" } }, "Size": { "type": "object", "properties": { "class": { "type": "string" } } } } }, "tags": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string" } } } }, "found_by": { "$ref": "#/components/schemas/CompanyFoundBy" } }, "required": [ "id" ] }, "SocialMedia": { "type": "object", "properties": { "network": { "type": "string", "description": "Social media network name" }, "id": { "type": "string", "description": "Identifier on the social network" }, "slug": { "type": "string", "description": "Slug / handle on the social network" }, "url": { "type": "string", "description": "Full profile URL" }, "url_status": { "type": "string", "description": "Status of the resolved URL", "enum": [ "", "unknown", "active" ] } } }, "SizeClass": { "type": "object", "properties": { "min": { "type": "integer", "description": "The minimum size of the class" }, "max": { "type": "integer", "description": "The maximum size of the class" } } }, "NetworkMapperItem": { "type": "object", "properties": { "profile": { "$ref": "#/components/schemas/NetworkMapperProfile" }, "connections": { "type": "array", "items": { "$ref": "#/components/schemas/NetworkMapperConnection" } } } }, "NetworkMapperProfile": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "full_name": { "type": "string" }, "current_title": { "type": "string" }, "linkedin_url": { "type": "string" }, "work_email": { "type": "string" }, "current_company_name": { "type": "string" }, "current_company_website": { "type": "string" } }, "required": [ "full_name" ] }, "NetworkMapperConnection": { "type": "object", "properties": { "connector_id": { "type": "string", "format": "uuid" }, "connector_name": { "type": "string" }, "connector_linkedin_url": { "type": "string" }, "connector_current_title": { "type": "string" }, "connector_current_company_name": { "type": "string" }, "connection_strength_normalized": { "type": "integer" }, "connection_strength": { "type": "number", "format": "float" }, "manual_strength": { "type": "number", "format": "float" }, "sources": { "type": "array", "items": { "$ref": "#/components/schemas/NetworkMapperConnectionSource" } } } }, "NetworkMapperConnectionSource": { "type": "object", "properties": { "origin": { "type": "string", "enum": [ "linkedin_connection", "work_overlap", "email_contact", "calendar_events", "manual_import", "education_overlap", "shared_investor" ] }, "shared_company": { "type": "string", "description": "Name of the shared company from work overlap" }, "shared_company_id": { "type": "string", "format": "uuid", "description": "ID of the shared company from work overlap" }, "shared_company_website": { "type": "string", "description": "Website of the shared company from work overlap" }, "shared_company_linkedin_slug": { "type": "string", "description": "Linkedin Slug of the shared company from work overlap" }, "overlap_start_date": { "type": "string", "description": "Start Date of work overlap" }, "overlap_end_date": { "type": "string", "description": "End Date of work overlap" }, "overlap_duration_months": { "type": "integer", "description": "Months Duration of work overlap" }, "shared_school": { "type": "string", "description": "Name of school from education overlap" }, "shared_major": { "type": "string", "description": "Name of major from education overlap" }, "graduation_year": { "type": "string", "description": "Graduation year from education overlap" }, "investor": { "type": "string", "description": "Name of common investor from investor overlap" }, "portfolio_company": { "type": "string", "description": "Name of portfolio company from investor overlap" } }, "required": [ "origin" ], "description": "Source of connection, only properties that describe given source are set" }, "Source": { "type": "object", "properties": { "origin": { "type": "string", "description": "The origin of the source" }, "network": { "type": "string", "description": "The network of the source" } }, "required": [ "origin", "network" ] }, "AddConnectorResponse": { "type": "object", "properties": { "usernames_not_found": { "type": "array", "items": { "type": "string" }, "description": "LinkedIn URL slugs that were not found" } } }, "SocialPost": { "type": "object", "properties": { "urn": { "type": "string", "description": "LinkedIn post URN" }, "actor": { "$ref": "#/components/schemas/SocialActor" }, "post_range": { "$ref": "#/components/schemas/SocialPostRange" }, "post_age": { "type": "string" }, "social_activity_counts": { "$ref": "#/components/schemas/SocialActivityCounts" }, "images": { "type": "array", "items": { "type": "string" } }, "url": { "type": "string" }, "video": { "$ref": "#/components/schemas/SocialVideo" }, "reshared_post": { "$ref": "#/components/schemas/SocialPost" }, "commentary": { "type": "string" }, "header": { "type": "string" }, "header_entity": { "$ref": "#/components/schemas/SocialHeaderEntity" } } }, "SocialActor": { "type": "object", "properties": { "linkedin_url": { "type": "string" }, "name": { "type": "string" }, "entity_type": { "type": "string" }, "image": { "type": "string" }, "linkedin_id": { "type": "string" } } }, "SocialPostRange": { "type": "object", "properties": { "earliest": { "type": "string" }, "latest": { "type": "string" } } }, "SocialActivityCounts": { "type": "object", "properties": { "comments_count": { "type": "integer" }, "shares_count": { "type": "integer" }, "reactions_count": { "type": "integer" }, "reaction_type_counts": { "type": "array", "items": { "$ref": "#/components/schemas/SocialReactionTypeCount" } } } }, "SocialReactionTypeCount": { "type": "object", "properties": { "count": { "type": "integer" }, "reaction_type": { "type": "string" } } }, "SocialVideo": { "type": "object", "properties": { "url": { "type": "string" }, "thumbnail": { "type": "string" } } }, "SocialHeaderEntity": { "type": "object", "properties": { "entity_type": { "type": "string" }, "image": { "type": "string" }, "linkedin_url": { "type": "string" }, "linkedin_id": { "type": "string" }, "name": { "type": "string" } } }, "SocialReaction": { "type": "object", "properties": { "reaction_type": { "type": "string" }, "reactor": { "$ref": "#/components/schemas/SocialReactor" } } }, "SocialReactor": { "type": "object", "properties": { "name": { "type": "string" }, "headline": { "type": "string" }, "linkedin_num_id": { "type": "integer" }, "linkedin_entity_id": { "type": "string" }, "image": { "type": "string" } } }, "SocialComment": { "type": "object", "properties": { "commentary": { "type": "string" }, "commenter": { "$ref": "#/components/schemas/SocialCommenter" }, "created_at": { "type": "string" }, "num_reactions": { "type": "integer" }, "num_comments": { "type": "integer" }, "reaction_type_counts": { "type": "array", "items": { "$ref": "#/components/schemas/SocialReactionTypeCount" } }, "comments": { "type": "array", "items": { "$ref": "#/components/schemas/SocialComment" }, "description": "Nested reply comments" } } }, "SocialCommenter": { "type": "object", "properties": { "image": { "type": "string" }, "linkedin_url": { "type": "string" }, "linkedin_id": { "type": "string" }, "name": { "type": "string" } } }, "Certification": { "type": "object", "properties": { "end_date": { "type": "string", "description": "The end / expiry date of the certification" }, "name": { "type": "string", "description": "The name of the certification" }, "organization": { "type": "string", "description": "The issuing organization" }, "start_date": { "type": "string", "description": "The start / issue date of the certification" } } }, "CompanyLocation": { "type": "object", "properties": { "name": { "type": "string", "description": "The name of the location" }, "city": { "type": "string", "description": "The city of the location" }, "state": { "type": "string", "description": "The state of the location" }, "country": { "type": "string", "description": "The country of the location" }, "street_address": { "type": "string", "description": "The street address of the location" }, "postal_code": { "type": "string", "description": "The postal code of the location" }, "headquarter": { "type": "boolean", "description": "Whether the location is the headquarter" } } }, "FoundBy": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "linkedinNames": { "type": "array", "items": { "type": "string" } }, "linkedinIds": { "type": "array", "items": { "type": "integer" } }, "linkedinEntityIds": { "type": "array", "items": { "type": "string" } } }, "description": "Which of the requested identifiers matched this result" }, "CompanyFoundBy": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "linkedinNames": { "type": "array", "items": { "type": "string" } }, "linkedinIds": { "type": "array", "items": { "type": "integer" } } }, "description": "Which of the requested identifiers matched this result" }, "ProfileFoundByV3": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "linkedin_names": { "type": "array", "items": { "type": "string" } }, "linkedin_ids": { "type": "array", "items": { "type": "integer" } }, "linkedin_entity_ids": { "type": "array", "items": { "type": "string" } } }, "description": "Which of the requested identifiers matched this result" }, "CompanyFoundByV3": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "linkedin_names": { "type": "array", "items": { "type": "string" } }, "linkedin_ids": { "type": "array", "items": { "type": "integer" } } }, "description": "Which of the requested identifiers matched this result" }, "JobCompanyV3": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "description": "The unique identifier of the company" }, "canonical_name": { "type": "string", "description": "The canonical name of the company" }, "name": { "type": "string", "description": "The name of the company" }, "founded": { "type": "string", "format": "date-time", "description": "The founding date of the company" }, "size": { "$ref": "#/components/schemas/SizeClass" }, "social_media": { "type": "array", "items": { "$ref": "#/components/schemas/CompanySocialMedia" }, "description": "The networks of the company" }, "locations": { "type": "array", "items": { "$ref": "#/components/schemas/CompanyLocationV3" }, "description": "The locations of the company" }, "industries": { "type": "array", "items": { "type": "string" }, "description": "The industries of the company" }, "websites": { "type": "array", "items": { "type": "string" }, "description": "The websites of the company" }, "logo_url": { "type": "string", "description": "Company logo URL (CDN)" } } }, "JobV3": { "type": "object", "properties": { "is_current": { "type": "boolean", "description": "Whether the job is primary or not" }, "company_id": { "type": "string", "description": "The unique identifier of the company in the job", "format": "uuid" }, "company": { "$ref": "#/components/schemas/JobCompanyV3" }, "title": { "type": "string", "description": "The title of the job" }, "seniorities": { "type": "array", "items": { "type": "string" }, "description": "The person's seniority in the job" }, "function": { "type": "string", "description": "The role/function in the job" }, "location": { "type": "array", "items": { "type": "string" }, "description": "Job location names" }, "description": { "type": "string", "description": "The description of the job" }, "start_date": { "type": "string", "format": "date", "description": "The start date of the job" }, "end_date": { "type": "string", "format": "date", "description": "The end date of the job" }, "status": { "type": "string", "description": "Experience status enum", "enum": [ "unknown", "past", "ongoing" ] }, "start_date_confidence": { "type": "string", "enum": [ "validated", "low" ], "description": "Confidence of the experience start date" } }, "required": [ "status" ] }, "ProfileInfoV3": { "type": "object", "properties": { "id": { "type": "string", "description": "The unique identifier of the profile", "format": "uuid" }, "full_name": { "type": "string", "description": "The full name of the profile" }, "first_name": { "type": "string", "description": "The first name of the profile" }, "last_name": { "type": "string", "description": "The last name of the profile" }, "headline": { "type": "string", "description": "The title of the current job" }, "about": { "type": "string", "description": "The industry of the profile" }, "linkedin_url": { "type": "string", "description": "The LinkedIn URL of the profile" }, "work_email": { "type": "string", "description": "The work email of the profile" }, "personal_emails": { "type": "array", "items": { "type": "string" }, "description": "The personal emails of the profile" }, "current_title": { "type": "string", "description": "The title of the current job" }, "current_function": { "type": "string", "description": "The role of the title in the current job" }, "current_seniorities": { "type": "array", "items": { "type": "string" }, "description": "The person's seniority in the current job" }, "current_company_id": { "type": "string", "description": "The unique identifier of the company in the current job", "format": "uuid" }, "current_company_name": { "type": "string", "description": "The name of the company in the current job" }, "current_company_logo_url": { "type": "string", "description": "The logo URL of the company in the current job" }, "current_company_size": { "$ref": "#/components/schemas/SizeClass" }, "current_company_location": { "type": "string", "description": "The location name of the company in the current job" }, "current_company_linkedin_url": { "type": "string", "description": "The LinkedIn URL of the company in the current job" }, "experience": { "type": "array", "items": { "$ref": "#/components/schemas/JobV3" }, "description": "The experience of the profile" }, "current_location": { "type": "string", "description": "The location name of the profile" }, "location_locality": { "type": "string", "description": "The locality (city) of the profile location" }, "location_region": { "type": "string", "description": "The region (state) of the profile location" }, "location_country": { "type": "string", "description": "The country of the profile location" }, "location_continent": { "type": "string", "description": "The continent of the profile location" }, "skills": { "type": "array", "items": { "type": "string" }, "description": "The skills of the profile" }, "education": { "type": "array", "items": { "$ref": "#/components/schemas/EducationV3" }, "description": "The education of the profile" }, "social_media": { "type": "array", "items": { "$ref": "#/components/schemas/ProfileSocialMedia" }, "description": "Social media profiles" }, "smart_tags": { "type": "array", "items": { "type": "string" }, "description": "AI-generated tags for the profile" }, "latest_role_change_at": { "type": "string", "format": "date", "description": "The date of the latest role change" }, "latest_company_change_at": { "type": "string", "format": "date", "description": "The date of the latest company change" }, "current_job_updated_at": { "type": "string", "format": "date-time", "description": "The update date of current job in the profile" }, "updated_at": { "type": "string", "format": "date-time", "description": "The update date of the profile" }, "created_at": { "type": "string", "format": "date-time", "description": "The creation date of the profile" }, "last_refresh_at": { "type": "string", "format": "date-time", "description": "The last refresh date of the profile" }, "current_company_websites": { "type": "array", "items": { "type": "string" }, "description": "The websites of the company in the current job" }, "current_company_industries": { "type": "array", "items": { "type": "string" }, "description": "The industries of the company in the current job" }, "certifications": { "type": "array", "items": { "$ref": "#/components/schemas/Certification" }, "description": "The certifications of the profile" }, "image_url": { "type": "string", "description": "Profile image URL (CDN)" }, "hiring": { "type": "boolean", "description": "Whether the person is hiring" }, "open_to_work": { "type": "boolean", "description": "Whether the person is open to work" } }, "required": [ "id" ] }, "ProfileV3": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "description": "The unique identifier of the profile" }, "lists": { "type": "array", "items": { "$ref": "#/components/schemas/PipelineV3" }, "description": "The lists of the profile" }, "tags": { "type": "array", "items": { "$ref": "#/components/schemas/TagV3" }, "description": "The tags of the profile" }, "profile_info": { "$ref": "#/components/schemas/ProfileInfoV3" }, "found_by": { "$ref": "#/components/schemas/ProfileFoundByV3" } }, "required": [ "id" ] }, "CompanyInfoV3": { "type": "object", "properties": { "id": { "type": "string" }, "linkedin_slugs": { "type": "array", "items": { "type": "string" } }, "name": { "type": "string" }, "alternative_names": { "type": "array", "items": { "type": "string" } }, "description": { "type": "string" }, "summary": { "type": "string" }, "contact_info": { "type": "object", "properties": { "email": { "type": "string" }, "phone": { "type": "string" }, "url": { "type": "string" } } }, "canonical_name": { "type": "string" }, "founded": { "type": "string", "format": "date-time" }, "workforce": { "type": "object", "properties": { "headcount": { "type": "integer" }, "historical_headcount": { "type": "array", "items": { "type": "object", "properties": { "timestamp": { "type": "integer" }, "count": { "type": "integer" } } } }, "size_class": { "type": "string" } } }, "tech_stack": { "type": "object", "properties": { "products": { "type": "array", "items": { "type": "string" } } } }, "business_data": { "type": "object", "properties": { "identifiers": { "type": "object", "properties": { "stock_ticker": { "type": "string" }, "duns_code": { "type": "string" }, "cage_code": { "type": "string" }, "naics_code": { "type": "string" } } }, "customer_types": { "type": "array", "items": { "type": "string" } }, "stock_exchange": { "type": "string" }, "is_acquired": { "type": "boolean" }, "is_exited": { "type": "boolean" }, "is_government": { "type": "boolean" }, "is_non_profit": { "type": "boolean" }, "is_shut_down": { "type": "boolean" }, "is_startup": { "type": "boolean" }, "is_stealth": { "type": "boolean" }, "ownership_status": { "type": "string" }, "ownership_status_detailed": { "type": "string" }, "patent_count": { "type": "integer" }, "financing_profile": { "type": "object", "properties": { "status": { "type": "string" }, "ipo_date": { "type": "string", "format": "date-time" }, "outstanding_shares": { "type": "number" }, "market_cap": { "type": "number" } } } } }, "social_media": { "type": "array", "items": { "$ref": "#/components/schemas/CompanySocialMedia" }, "description": "The networks of the company" }, "locations": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "country": { "type": "string" }, "is_primary": { "type": "boolean" } } } }, "logo_url": { "type": "string" }, "investor": { "type": "object", "properties": { "type": { "type": "array", "items": { "type": "string" } }, "specialities": { "type": "array", "items": { "type": "string" } }, "investments": { "type": "array", "items": { "type": "string" } }, "geography_focus": { "type": "array", "items": { "type": "string" } } } }, "funding": { "type": "object", "properties": { "last_round": { "type": "object", "properties": { "last_round_type": { "type": "string" }, "last_round_amount_usd": { "type": "number" }, "last_round_date": { "type": "string", "format": "date-time" }, "last_round_investors": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "kind": { "type": "string", "enum": [ "Unknown", "Profile", "Company" ], "description": "Investor kind" }, "name": { "type": "string" }, "crunchbase_slug": { "type": "string" } } } } } }, "rounds": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string" }, "amount_usd": { "type": "number" }, "date": { "type": "string", "format": "date-time" }, "investors": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "kind": { "type": "string", "enum": [ "Unknown", "Profile", "Company" ], "description": "Investor kind" }, "name": { "type": "string" }, "crunchbase_slug": { "type": "string" } } } } } } }, "total_funding_amount_usd": { "type": "number" } } }, "updated_at": { "type": "string", "format": "date-time" }, "industries": { "type": "array", "items": { "type": "string" } }, "websites": { "type": "array", "items": { "type": "string" } } }, "required": [ "name" ] }, "CompanyV3": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "description": "The unique identifier of the company" }, "company_info": { "$ref": "#/components/schemas/CompanyInfoV3" }, "tags": { "type": "array", "items": { "$ref": "#/components/schemas/TagV3" }, "description": "The tags of the company" }, "found_by": { "$ref": "#/components/schemas/CompanyFoundByV3" } }, "required": [ "id" ] }, "CompanySocialMedia": { "type": "object", "properties": { "network": { "type": "string", "description": "Social media network name" }, "id": { "type": "string", "description": "Identifier on the social network" }, "slug": { "type": "string", "description": "Slug / handle on the social network" }, "url": { "type": "string", "description": "Full profile URL" } } }, "ProfileSocialMedia": { "type": "object", "properties": { "network": { "type": "string", "description": "Social media network name" }, "id": { "type": "string", "description": "Identifier on the social network" }, "entity_id": { "type": "string", "description": "Persistent entity identifier on the social network" }, "url": { "type": "string", "description": "Full profile URL" }, "connections": { "type": "integer", "description": "Number of connections on the social network" }, "followers": { "type": "integer", "description": "Number of followers on the social network" }, "slug": { "type": "string", "description": "Slug / handle on the social network" }, "join_date": { "type": "string", "description": "Date the profile joined the network (YYYY-MM-DD)" }, "url_status": { "type": "string", "description": "Status of the resolved URL", "enum": [ "", "unknown", "active" ] } } }, "LocationV3": { "type": "object", "properties": { "name": { "type": "string", "description": "The name of the location" }, "city": { "type": "string", "description": "The city of the location" }, "state": { "type": "string", "description": "The state of the location" }, "country": { "type": "string", "description": "The country of the location" } } }, "SchoolV3": { "type": "object", "properties": { "name": { "type": "string", "description": "The name of the school" }, "location": { "$ref": "#/components/schemas/LocationV3" }, "website": { "type": "string", "description": "The website of the school" }, "linkedin_url": { "type": "string", "description": "Linkedin profile URL of the school" }, "linkedin_id": { "type": "integer", "description": "Linkedin numeric id of the school" } } }, "EducationV3": { "type": "object", "properties": { "school": { "$ref": "#/components/schemas/SchoolV3" }, "start_date": { "type": "string", "format": "date", "description": "The start date of the education" }, "end_date": { "type": "string", "format": "date", "description": "The end date of the education" }, "degrees": { "type": "array", "items": { "type": "string" }, "description": "The degrees of the education" }, "majors": { "type": "array", "items": { "type": "string" }, "description": "The majors of the education" }, "activities": { "type": "string", "description": "The activities of the education" }, "grade": { "type": "string", "description": "The grade of the education" }, "description": { "type": "string", "description": "The description of the education" } } }, "CompanyLocationV3": { "type": "object", "properties": { "name": { "type": "string", "description": "The name of the location" }, "city": { "type": "string", "description": "The city of the location" }, "state": { "type": "string", "description": "The state of the location" }, "country": { "type": "string", "description": "The country of the location" }, "is_primary": { "type": "boolean", "description": "Whether the location is the primary (headquarter) location" } } }, "TagV3": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "description": "The unique identifier of the tag" }, "name": { "type": "string", "description": "The name of the tag" } }, "required": [ "id", "name" ] }, "PipelineV3": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "description": "The unique identifier of the pipeline" }, "name": { "type": "string", "description": "The name of the pipeline" }, "status": { "type": "string", "description": "The status of the pipeline" } }, "required": [ "id", "name", "status" ] } }, "responses": { "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "402": { "description": "Payment required - the team's API credit allowance has been exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "5XX": { "description": "Unexpected error" } }, "securitySchemes": { "ApiKeyAuth": { "type": "apiKey", "in": "header", "name": "x-api-key" } }, "parameters": { "AuthenticateTeamHeader": { "name": "x-authenticate-team", "in": "header", "required": false, "description": "Partner accounts only. When present, the request is executed in the context of the specified child team (use the `team_id` returned by [Create Team](/docs/endpoints/v3/create-team)). When omitted, the request runs as the team that owns the API key.", "schema": { "type": "string" } } } } }