Overview
Section titled “Overview”LinkedIn is the world’s largest professional networking platform, connecting professionals, companies, and thought leaders to create content, generate business opportunities, and advance careers. With the LinkedIn integration in SquadOS, your agents can publish posts and articles, engage with content, manage media, and access organizational page analytics directly through the API.
- Official website: https://www.linkedin.com/
- Composio documentation: docs.composio.dev/toolkits/linkedin
Authentication
Section titled “Authentication”This tool uses OAuth 2.0 (OAUTH2) to connect.
Authentication is handled via OAuth flow in the browser — when you click Connect, you will be redirected to Composio’s secure page where you authorize access to your LinkedIn account. No manual credentials are required.
How to connect in SquadOS
Section titled “How to connect in SquadOS”- Go to Tools in the side menu (
/admin/tools). - Open the Available tab and search for
LinkedIn. - Click the card to open the details modal and hit Connect.
- You’re taken to the secure connection page hosted by Composio, where you authorize access (OAuth).
- Once done, you’re sent back to SquadOS with the account connected and the tool available for your agents. (Connection-flow details in Organization Tools.)
How do I set up custom OAuth credentials for LinkedIn?
Section titled “How do I set up custom OAuth credentials for LinkedIn?”For a step-by-step guide on creating and configuring your own LinkedIn OAuth credentials with Composio, see How to create OAuth credentials for LinkedIn.
Why am I getting 429 rate limit errors on LinkedIn?
Section titled “Why am I getting 429 rate limit errors on LinkedIn?”The default OAuth app is shared across users and has strict rate limits. Use your own OAuth app for production to avoid shared quotas.
Why can’t I use certain LinkedIn scope combinations?
Section titled “Why can’t I use certain LinkedIn scope combinations?”LinkedIn restricts certain scope combinations. For example, w_member_social and r_organization_admin cannot be used together. If you need conflicting scopes, create your own OAuth app with the required permissions.
Available actions
Section titled “Available actions”Create article or URL share
Section titled “Create article or URL share”LINKEDIN_CREATE_ARTICLE_OR_URL_SHARE
Tool to create an article or URL share on LinkedIn using the UGC Posts API. Use when you need to share a link with optional commentary on LinkedIn. Supports sharing URLs as articles with customizable visibility settings.
Input parameters
Section titled “Input parameters”| Name | Type | Required | Description |
|---|---|---|---|
author | string | Yes | URN of the author (person or organization). For a person: 'urn:li:person:{id}'. For an organization: 'urn:li:organization:{id}'. Use GET_MY_INFO action to get your person ID. |
visibility | object | Yes | Visibility settings for the post. Controls who can see the shared content. |
lifecycleState | string ("PUBLISHED" | "DRAFT") | No | State of the post. Use 'PUBLISHED' to post immediately or 'DRAFT' to save as draft. |
specificContent | object | Yes | Container for the share content including URL, commentary, and media category. |
Output
Section titled “Output”| Name | Type | Required | Description |
|---|---|---|---|
data | string | Yes | Data from the action execution. |
error | string | No | Error if any occurred during the execution of the action. |
successful | boolean | Yes | Whether or not the action execution was successful. |
Create comment on LinkedIn post
Section titled “Create comment on LinkedIn post”LINKEDIN_CREATE_COMMENT_ON_POST
Tool to create a first-level or nested comment on a LinkedIn share, UGC post, or parent comment via the Social Actions Comments API. Use when you need to engage with posts by adding comments or replying to existing comments. Supports text comments with optional @-mentions and image attachments.
Input parameters
Section titled “Input parameters”| Name | Type | Required | Description |
|---|---|---|---|
actor | string | Yes | Entity which authored the comment. For personal comments: 'urn:li:person:{id}'. For organization comments: 'urn:li:organization:{id}'. Use the GET_USER_INFO action to retrieve the id field. |
object | string | Yes | The URN of the share or ugcPost that contains the comment. Typically the same as target_urn for first-level comments, or the root post URN for nested comments. Must be 'urn:li:share:{id}' or 'urn:li:ugcPost:{id}'. Activity URNs ('urn:li:activity:{id}') are NOT supported. |
content | array | No | Array of content entities such as images to include in the comment. Each entity should contain an image URN or other content type. |
message | object | Yes | The comment message content including text and optional @-mentions. |
target_urn | string | Yes | The URN of the share, UGC post, or parent comment where the comment will be created. Must be 'urn:li:share:{id}', 'urn:li:ugcPost:{id}', or 'urn:li:comment:({parentUrn},{commentId})'. Activity URNs are NOT supported. |
parentComment | string | No | For nested comments (replies), the URN of the parent comment being replied to. Format: 'urn:li:comment:({parentUrn},{commentId})'. Leave empty for first-level comments on the post. |
Output
Section titled “Output”| Name | Type | Required | Description |
|---|---|---|---|
data | string | Yes | Data from the action execution. |
error | string | No | Error if any occurred during the execution of the action. |
successful | boolean | Yes | Whether or not the action execution was successful. |
Create a LinkedIn post
Section titled “Create a LinkedIn post”LINKEDIN_CREATE_LINKED_IN_POST
Creates a new post on LinkedIn for the authenticated user or an organization they manage. Requires w_member_social scope for posting as a person, and w_organization_social scope for posting as an organization (with ADMINISTRATOR, DIRECT_SPONSORED_CONTENT_POSTER, or CONTENT_ADMIN role).
Input parameters
Section titled “Input parameters”| Name | Type | Required | Description |
|---|---|---|---|
author | string | Yes | The URN of the LinkedIn member or organization creating the post. For a person: 'urn:li:person:{id}' (e.g., 'urn:li:person:F6kGF1Uduq'). For an organization: 'urn:li:organization:{id}'. Get your person ID using GET_MY_INFO, or get organization IDs from GET_COMPANY_INFO. |
images | array | No | Array of images to upload and attach to the post. Supports 1-20 images. |
container | string | No | Container entity URN for posting within a specific container (e.g., 'urn:li:group:123456' for group posts). |
commentary | string | Yes | The main text content of the post. Supports plain text and @-mentions. Maximum length: 3000 characters. |
visibility | string ("PUBLIC" | "CONNECTIONS" | "LOGGED_IN" | "CONTAINER") | No | Controls who can see the post. 'PUBLIC' makes it visible to everyone, 'CONNECTIONS' to connections only, 'LOGGED_IN' to signed-in LinkedIn members, and 'CONTAINER' for specific group/event posts. |
distribution | object | No | Specifies distribution rules for the post, including feed distribution and targeting. |
lifecycleState | string | No | The state of the post. Use 'PUBLISHED' to post directly, 'DRAFT' to save as a draft, or 'PUBLISH_REQUESTED' if the post requires review before publishing. |
reshareContext | object | No | Context for resharing another post. |
contentLandingPage | string | No | URL of the landing page that opens when the call-to-action button is clicked. Required when contentCallToActionLabel is specified. |
contentCallToActionLabel | string | No | Call-to-action button labels for posts. Values: "APPLY", "DOWNLOAD", "VIEW_QUOTE", "LEARN_MORE", "SIGN_UP", "SUBSCRIBE", "REGISTER", "JOIN", "ATTEND", "REQUEST_DEMO", "SEE_MORE", "BUY_NOW", "SHOP_NOW". |
isReshareDisabledByAuthor | boolean | No | Set to true to prevent others from resharing this post. |
Output
Section titled “Output”| Name | Type | Required | Description |
|---|---|---|---|
data | string | Yes | Data from the action execution. |
error | string | No | Error if any occurred during the execution of the action. |
successful | boolean | Yes | Whether or not the action execution was successful. |
Delete LinkedIn Post
Section titled “Delete LinkedIn Post”LINKEDIN_DELETE_LINKED_IN_POST
Deletes a specific LinkedIn post (share) by its unique share_id, which must correspond to an existing share.
Input parameters
Section titled “Input parameters”| Name | Type | Required | Description |
|---|---|---|---|
share_id | string | Yes | Unique identifier of the LinkedIn share (post) to be deleted. Accepts either numeric ID (e.g., '7245341016004718592') or URN format (e.g., 'urn:li:share:7245341016004718592'). |
Output
Section titled “Output”| Name | Type | Required | Description |
|---|---|---|---|
data | string | Yes | Data from the action execution. |
error | string | No | Error if any occurred during the execution of the action. |
successful | boolean | Yes | Whether or not the action execution was successful. |
Delete Post
Section titled “Delete Post”LINKEDIN_DELETE_POST
Delete a LinkedIn post using the Posts API REST endpoint. Supports both ugcPost and share URN formats. The endpoint is idempotent - previously deleted posts return success (204).
Input parameters
Section titled “Input parameters”| Name | Type | Required | Description |
|---|---|---|---|
post_urn | string | Yes | The URN of the post to delete. Accepts either ugcPost or share URN formats (e.g., 'urn:li:ugcPost:7890123456' or 'urn:li:share:7245341016004718592'). The URN will be URL-encoded automatically. |
Output
Section titled “Output”| Name | Type | Required | Description |
|---|---|---|---|
data | string | Yes | Data from the action execution. |
error | string | No | Error if any occurred during the execution of the action. |
successful | boolean | Yes | Whether or not the action execution was successful. |
Delete UGC Post (Legacy)
Section titled “Delete UGC Post (Legacy)”LINKEDIN_DELETE_UGC_POST
Delete a UGC post using the legacy UGC Post API endpoint. Use when you need to delete a post using the v2/ugcPosts endpoint. Deletion is idempotent - previously deleted posts also return success.
Input parameters
Section titled “Input parameters”| Name | Type | Required | Description |
|---|---|---|---|
ugc_post_urn | string | Yes | The URN of the UGC post or share to delete. Format: 'urn:li:ugcPost:{id}' or 'urn:li:share:{id}'. Will be URL-encoded automatically by the action. |
Output
Section titled “Output”| Name | Type | Required | Description |
|---|---|---|---|
data | string | Yes | Data from the action execution. |
error | string | No | Error if any occurred during the execution of the action. |
successful | boolean | Yes | Whether or not the action execution was successful. |
Get ad targeting facets
Section titled “Get ad targeting facets”LINKEDIN_GET_AD_TARGETING_FACETS
Tool to retrieve available ad targeting facets from LinkedIn Marketing API. Use when you need to discover what targeting options are available for ad campaigns (e.g., locations, industries, job functions).
Output
Section titled “Output”| Name | Type | Required | Description |
|---|---|---|---|
data | string | Yes | Data from the action execution. |
error | string | No | Error if any occurred during the execution of the action. |
successful | boolean | Yes | Whether or not the action execution was successful. |
Get audience counts
Section titled “Get audience counts”LINKEDIN_GET_AUDIENCE_COUNTS
Retrieves audience size counts for specified targeting criteria. Use when estimating reach for LinkedIn ad campaigns or targeted content.
Input parameters
Section titled “Input parameters”| Name | Type | Required | Description |
|---|---|---|---|
q | string ("targetingCriteriaV2") | No | Query type parameter. Must be 'targetingCriteriaV2' for targeting criteria queries. |
targetingCriteria | string | Yes | Targeting criteria with URL-encoded URNs. Format: (include:(and:List((or:(urn%3Ali%3AadTargetingFacet%3AFACET:List(urn%3Ali%3ATYPE%3AID)))))). IMPORTANT: Only the URN colons should be encoded as %3A, keep the structure syntax (parentheses, colons in 'and:' and 'or:') unencoded. |
Output
Section titled “Output”| Name | Type | Required | Description |
|---|---|---|---|
data | string | Yes | Data from the action execution. |
error | string | No | Error if any occurred during the execution of the action. |
successful | boolean | Yes | Whether or not the action execution was successful. |
Get company info
Section titled “Get company info”LINKEDIN_GET_COMPANY_INFO
Retrieves organizations where the authenticated user has specific roles (ACLs), to determine their management or content posting capabilities for LinkedIn company pages.
Input parameters
Section titled “Input parameters”| Name | Type | Required | Description |
|---|---|---|---|
role | string ("ADMINISTRATOR" | "DIRECT_SPONSORED_CONTENT_POSTER") | No | The specific role to filter organization ACLs by. |
count | integer | No | The number of organization ACLs to return per page. |
start | integer | No | The starting index for pagination, representing the number of initial ACLs to skip. |
state | string ("APPROVED" | "REQUESTED") | No | The approval state of the role to filter by. |
Output
Section titled “Output”| Name | Type | Required | Description |
|---|---|---|---|
data | string | Yes | Data from the action execution. |
error | string | No | Error if any occurred during the execution of the action. |
successful | boolean | Yes | Whether or not the action execution was successful. |
Get image details
Section titled “Get image details”LINKEDIN_GET_IMAGE
Tool to retrieve details of a LinkedIn image using its URN. Use when you need to check image status, get download URLs, or access image metadata for a single image.
Input parameters
Section titled “Input parameters”| Name | Type | Required | Description |
|---|---|---|---|
image_urn | string | Yes | The image URN identifier. Can be provided as 'urn:li:image:XXX' or just the ID 'XXX'. The URN will be URL-encoded automatically when making the API request. |
Output
Section titled “Output”| Name | Type | Required | Description |
|---|---|---|---|
data | string | Yes | Data from the action execution. |
error | string | No | Error if any occurred during the execution of the action. |
successful | boolean | Yes | Whether or not the action execution was successful. |
Get images
Section titled “Get images”LINKEDIN_GET_IMAGES
Tool to retrieve image metadata including download URLs, status, and dimensions from LinkedIn’s Images API. Use when you need to access image details for posts, profiles, or media library assets.
Input parameters
Section titled “Input parameters”| Name | Type | Required | Description |
|---|---|---|---|
ids | array | Yes | List of image URNs to retrieve. Each URN should be in the format 'urn:li:image:{ID}' (e.g., 'urn:li:image:C4E10AQFn10iWtKexVA'). Maximum recommended batch size depends on LinkedIn’s API limits. |
Output
Section titled “Output”| Name | Type | Required | Description |
|---|---|---|---|
data | string | Yes | Data from the action execution. |
error | string | No | Error if any occurred during the execution of the action. |
successful | boolean | Yes | Whether or not the action execution was successful. |
Get my info
Section titled “Get my info”LINKEDIN_GET_MY_INFO
Fetches the authenticated LinkedIn user’s profile information including name, headline, profile picture, and other profile details.
Output
Section titled “Output”| Name | Type | Required | Description |
|---|---|---|---|
data | string | Yes | Data from the action execution. |
error | string | No | Error if any occurred during the execution of the action. |
successful | boolean | Yes | Whether or not the action execution was successful. |
Get network size
Section titled “Get network size”LINKEDIN_GET_NETWORK_SIZE
Tool to retrieve the follower count for a LinkedIn organization. Use when you need to get the number of members following a specific company or organization on LinkedIn.
Input parameters
Section titled “Input parameters”| Name | Type | Required | Description |
|---|---|---|---|
edgeType | string ("COMPANY_FOLLOWED_BY_MEMBER") | No | The type of network relationship to count. Use COMPANY_FOLLOWED_BY_MEMBER to get follower count. |
organization_id | string | Yes | The unique identifier for the LinkedIn organization. This is the numeric ID from the organization URN (e.g., for 'urn:li:organization:3803', use '3803'). |
Output
Section titled “Output”| Name | Type | Required | Description |
|---|---|---|---|
data | string | Yes | Data from the action execution. |
error | string | No | Error if any occurred during the execution of the action. |
successful | boolean | Yes | Whether or not the action execution was successful. |
Get organization page statistics
Section titled “Get organization page statistics”LINKEDIN_GET_ORG_PAGE_STATS
Tool to retrieve page statistics for a LinkedIn organization page. Use when you need engagement metrics like page views and custom button clicks. Supports both lifetime statistics (all-time data segmented by demographics) and time-bound statistics (aggregate data for specific time ranges). Requires rw_organization_admin permission with ADMINISTRATOR role for the organization.
Input parameters
Section titled “Input parameters”| Name | Type | Required | Description |
|---|---|---|---|
organization | string | Yes | Organization URN in format urn:li:organization:{id}. Example: urn:li:organization:2414183. |
timeRangeEnd | integer | No | Inclusive ending timestamp in milliseconds since epoch. Only required for time-bound statistics. Omit for lifetime statistics. |
timeRangeStart | integer | No | Exclusive starting timestamp in milliseconds since epoch. Only required for time-bound statistics. Omit for lifetime statistics. |
timeGranularityType | string ("DAY" | "MONTH") | No | Granularity of the statistics. Use DAY for daily statistics or MONTH for monthly statistics. Only required for time-bound statistics. |
Output
Section titled “Output”| Name | Type | Required | Description |
|---|---|---|---|
data | string | Yes | Data from the action execution. |
error | string | No | Error if any occurred during the execution of the action. |
successful | boolean | Yes | Whether or not the action execution was successful. |
Get person profile
Section titled “Get person profile”LINKEDIN_GET_PERSON
Retrieves a LinkedIn member’s profile information by their person ID. Returns lite profile fields (name, profile picture) by default, or basic profile fields (including headline and vanity name) with appropriate permissions.
Input parameters
Section titled “Input parameters”| Name | Type | Required | Description |
|---|---|---|---|
person_id | string | Yes | The unique identifier of the LinkedIn member. Note: Each member id is unique to the context of your application only. |
Output
Section titled “Output”| Name | Type | Required | Description |
|---|---|---|---|
data | string | Yes | Data from the action execution. |
error | string | No | Error if any occurred during the execution of the action. |
successful | boolean | Yes | Whether or not the action execution was successful. |
Get post content
Section titled “Get post content”LINKEDIN_GET_POST_CONTENT
Tool to retrieve detailed post content including text, images, videos, and metadata from LinkedIn by post URN. Use when you need to fetch the full content and details of a specific LinkedIn post.
Input parameters
Section titled “Input parameters”| Name | Type | Required | Description |
|---|---|---|---|
post_id | string | Yes | Post URN identifier in the format 'urn:li:ugcPost:{id}' or 'urn:li:share:{id}'. Can also be URL-encoded. Example: 'urn:li:ugcPost:7428263313739988992'. |
Output
Section titled “Output”| Name | Type | Required | Description |
|---|---|---|---|
data | string | Yes | Data from the action execution. |
error | string | No | Error if any occurred during the execution of the action. |
successful | boolean | Yes | Whether or not the action execution was successful. |
Get share statistics
Section titled “Get share statistics”LINKEDIN_GET_SHARE_STATS
Retrieves share statistics for a LinkedIn organization, including impressions, clicks, likes, comments, and shares. Use to analyze content performance for an organization page. Optionally filter by time intervals to get time-bound statistics.
Input parameters
Section titled “Input parameters”| Name | Type | Required | Description |
|---|---|---|---|
time_intervals | string | No | Time-bound statistics filter in RestLi 2.0 complex object format. Specify time range and granularity as: '(timeRange:(start:<start_timestamp>,end:<end_timestamp>),timeGranularityType:<GRANULARITY>)' where timestamps are in milliseconds since epoch and GRANULARITY is one of: DAY, WEEK, MONTH. If omitted, returns lifetime statistics. |
organizational_entity | string | Yes | The URN of the organization to retrieve share statistics for. Must be in the format 'urn:li:organization:<id>' (e.g., 'urn:li:organization:2414183'). Get organization IDs using the GET_COMPANY_INFO action. |
Output
Section titled “Output”| Name | Type | Required | Description |
|---|---|---|---|
data | string | Yes | Data from the action execution. |
error | string | No | Error if any occurred during the execution of the action. |
successful | boolean | Yes | Whether or not the action execution was successful. |
Get videos
Section titled “Get videos”LINKEDIN_GET_VIDEOS
Retrieves video metadata from LinkedIn Marketing API. Supports single video retrieval, batch retrieval (multiple videos), and finding videos by associated account with pagination. Use when you need to get video details including duration, dimensions, status, download URLs, and media library information.
Input parameters
Section titled “Input parameters”| Name | Type | Required | Description |
|---|---|---|---|
count | integer | No | Number of elements to return for pagination, up to 1,000. Only used with 'associated_account'. Defaults to 10. |
start | integer | No | Index where returned elements begin for pagination. Only used with 'associated_account'. Defaults to 0. |
video_ids | array | No | List of video URNs for batch retrieval (e.g., ['urn:li:video:C4D10AQE9WE5n4uJKUg', 'urn:li:video:C5F10AQElP1fVH1Ke6g']). Mutually exclusive with 'video_urn' and 'associated_account'. |
video_urn | string | No | Single video URN to retrieve (e.g., 'urn:li:video:C4E10AQGUkQY7trgh-Q'). Mutually exclusive with 'video_ids' and 'associated_account'. |
associated_account | string | No | Sponsored account URN to find videos by associated account (e.g., 'urn:li:sponsoredAccount:123456789'). Mutually exclusive with 'video_urn' and 'video_ids'. |
media_library_status | string ("ACTIVE" | "ARCHIVED") | No | Filter by media library status. Only used with 'associated_account'. When omitted, returns all videos regardless of status. |
Output
Section titled “Output”| Name | Type | Required | Description |
|---|---|---|---|
data | string | Yes | Data from the action execution. |
error | string | No | Error if any occurred during the execution of the action. |
successful | boolean | Yes | Whether or not the action execution was successful. |
Initialize image upload
Section titled “Initialize image upload”LINKEDIN_INITIALIZE_IMAGE_UPLOAD
Tool to initialize an image upload to LinkedIn and return a presigned upload URL plus the resulting image URN. Use when you need to prepare an image upload for LinkedIn posts. After calling this tool, upload the image bytes to the returned upload_url via PUT request, then use the image URN in CREATE_LINKED_IN_POST action.
Input parameters
Section titled “Input parameters”| Name | Type | Required | Description |
|---|---|---|---|
owner | string | Yes | Owner URN (person or organization) that will own the uploaded image. Must be in the format 'urn:li:person:{id}' for personal posts or 'urn:li:organization:{id}' for organization posts. Use the GET_MY_INFO action to retrieve the person ID. |
Output
Section titled “Output”| Name | Type | Required | Description |
|---|---|---|---|
data | string | Yes | Data from the action execution. |
error | string | No | Error if any occurred during the execution of the action. |
successful | boolean | Yes | Whether or not the action execution was successful. |
List reactions on entity
Section titled “List reactions on entity”LINKEDIN_LIST_REACTIONS
Retrieves reactions (likes, celebrations, etc.) on a LinkedIn entity such as a share, post, or comment. Use when you need to see who reacted to content and what type of reactions were used.
Input parameters
Section titled “Input parameters”| Name | Type | Required | Description |
|---|---|---|---|
sort | string ("CHRONOLOGICAL" | "REVERSE_CHRONOLOGICAL" | "RELEVANCE") | No | Sort order for reactions. CHRONOLOGICAL sorts by created date ascending, REVERSE_CHRONOLOGICAL sorts by created date descending (default), RELEVANCE sorts by relevance to the viewer. |
count | integer | No | Number of reactions to return per page. |
start | integer | No | Starting index for pagination (number of reactions to skip). |
entity | string | Yes | The URN of the entity (share, post, or comment) to get reactions for. Format: 'urn:li:share:{id}', 'urn:li:ugcPost:{id}', 'urn:li:activity:{id}', or 'urn:li:comment:(activity:{activityId},{commentId})'. Do not URL-encode this value. |
Output
Section titled “Output”| Name | Type | Required | Description |
|---|---|---|---|
data | string | Yes | Data from the action execution. |
error | string | No | Error if any occurred during the execution of the action. |
successful | boolean | Yes | Whether or not the action execution was successful. |
Register image upload
Section titled “Register image upload”LINKEDIN_REGISTER_IMAGE_UPLOAD
Tool to initialize a native LinkedIn image upload for feed shares and return a presigned upload URL plus the resulting digital media asset URN. Use when you need to upload an image to attach to a LinkedIn post. After calling this tool, upload the image bytes to the returned upload_url, then use the asset_urn in LINKEDIN_CREATE_LINKED_IN_POST.
Input parameters
Section titled “Input parameters”| Name | Type | Required | Description |
|---|---|---|---|
recipe | string | No | The digital media recipe URN specifying the processing recipe for the image. Default is 'urn:li:digitalmediaRecipe:feedshare-image' for feed share images. |
owner_urn | string | Yes | URN of the owner entity that will own the uploaded image. Must be in the format 'urn:li:person:{id}' for personal posts or 'urn:li:organization:{id}' for organization posts. Use the GET_USER_INFO action to retrieve the person ID. |
supported_upload_mechanism | array | No | Array of supported upload mechanisms. If not specified, LinkedIn will return the default mechanism (typically SYNCHRONOUS_UPLOAD). |
Output
Section titled “Output”| Name | Type | Required | Description |
|---|---|---|---|
data | string | Yes | Data from the action execution. |
error | string | No | Error if any occurred during the execution of the action. |
successful | boolean | Yes | Whether or not the action execution was successful. |
Search ad targeting entities
Section titled “Search ad targeting entities”LINKEDIN_SEARCH_AD_TARGETING_ENTITIES
Search for ad targeting entities using typeahead search. Use when you need to find targeting entities like geographic locations, job titles, industries, or other targeting criteria for LinkedIn ad campaigns.
Input parameters
Section titled “Input parameters”| Name | Type | Required | Description |
|---|---|---|---|
count | integer | No | Maximum number of results to return per page. |
facet | string | Yes | Ad targeting facet URN to specify the entity type to search (e.g., 'urn:li:adTargetingFacet:locations' for geographic locations, 'urn:li:adTargetingFacet:titles' for job titles, 'urn:li:adTargetingFacet:industries' for industries). |
query | string | Yes | Search query string to find targeting entities (e.g., 'united states', 'software engineer', 'technology'). |
start | integer | No | Starting index for pagination, representing the number of initial results to skip. |
queryVersion | string ("QUERY_USES_URNS") | No | Query version for the search request. |
Output
Section titled “Output”| Name | Type | Required | Description |
|---|---|---|---|
data | string | Yes | Data from the action execution. |
error | string | No | Error if any occurred during the execution of the action. |
successful | boolean | Yes | Whether or not the action execution was successful. |