Organizations

Warning

Deprecation Notice
The employeeExperienceSettingsV2 field will no longer be available starting with the February 2025 release version. For older versions, this field will return null. See the recent changes summary page for more details.

Try in Postman

The Organizations API returns the organization (i.e. Company, School and Showcase) data with necessary member filtering needed for DMA.

The service provides the following methods:

  • Get an organization.
  • Batch get organizations.
  • Finder parentOrganization to return all organizations which are children of the given organization.
  • Finder vanityName to potentially return an organization that has the vanity name provided.
  • Finder emailDomain to return Organization which has the specified email domain.

Pages Organization Example

Pages Organization Example

Permissions

Permission Description
r_dma_admin_pages_content Retrieve your organization’s posts, comments, reactions, and other engagement data. Retrieve your organization’s pages and their reporting data (including follower, visitor and content analytics). Restricted to organizations in which the authenticated member has one of the following company page roles.
  • ADMINISTRATOR

See Organization Access Control for more information on company page roles.

Member Data Obfuscation

This DMA API has member data that is obfuscated.

Field Description
created.actor The entity which will be credited for moving the resource/association/sub-resource into the specific lifecycle stage. The field is only populated if the actor has granted permission to share their data via DMA API.
created.impersonator The entity which performs the change on behalf of the actor and must be authorized to act as the actor. The field is only populated if the member has granted permission to share their data via DMA API.
lastModified.actor The entity which will be credited for moving the resource/association/sub-resource into the specific lifecycle stage. The field is only populated if the actor has granted permission to share their data via DMA API.
lastModified.impersonator The entity which performs the change on behalf of the actor and must be authorized to act as the actor. The field is only populated if the member has granted permission to share their data via DMA API.
deleted.actor The entity which will be credited for moving the resource/association/sub-resource into the specific lifecycle stage. The field is only populated if the actor has granted permission to share their data via DMA API.
deleted.impersonator The entity which performs the change on behalf of the actor and must be authorized to act as the actor. The field is only populated if the member has granted permission to share their data via DMA API.
lastModifiedByAdmin.actor The entity which will be credited for moving the resource/association/sub-resource into the specific lifecycle stage. The field is only populated if the actor has granted permission to share their data via DMA API.
lastModifiedByAdmin.impersonator The entity which performs the change on behalf of the actor and must be authorized to act as the actor. The field is only populated if the member has granted permission to share their data via DMA API.

Schema

Organization

Note

Either of the created / lastmodified / deleted fields will always be present in the response schema.

Field Format Description Required
created AuditStamp An AuditStamp corresponding to the creation of this resource/association/sub-resource. No
lastModified AuditStamp An AuditStamp corresponding to the last modification of this resource/association/sub-resource. No
deleted AuditStamp An AuditStamp corresponding to the deletion of this resource/association/sub-resource. No
id long ID of the entity. Yes
vanityName String Entity's unique name used in URLs. Yes
entityStatus EntityStatus Status of the entity, such as active or inactive. Value enums include:
  • ACTIVE
  • INACTIVE
 Yes
autoCreated boolean Whether the entity was auto-created. Yes
description MultiLocaleString The entity's description. No
localizedDescription String The locale-specific description of the entity. No
tagline MultiLocaleString The entity's tagline. No
localizedTagline String The locale-specific tagline of the entity. No
logoV2 OrganizationCroppedImage Logo photo uploaded via Vector. No
coverPhotoV2 OrganizationCroppedImage Cover photo uploaded via Vector. The entity's background cover image. No
name MultiLocaleString Name of the entity. Yes
localizedName String The locale-specific name of the entity. No
alternativeNames array[LocaleString] Alternative names of the entity. There can be multiple names per locale. Yes
defaultLocale array[Locale] Default locale of the entity. Yes
website MultiLocaleString The entity's website. No
localizedWebsite String The locale-specific website of the entity. No
foundedOn Date When the entity was founded. No
specialties array[LocaleTags] Admin-defined specialty tags of the entity. Yes
localizedSpecialties array[String] The locale-specific, admin-defined specialty tags of the entity. Yes
pinnedPost URN The entity's pinned post. No
primaryPhoneNumber PhoneNumber The primary phone number for the entity. No
emailAddress String Email address of the entity. No
lastModifiedByAdmin AuditStamp Timestamp of last modification done by organizational entity admin. No
callToAction OrganizationCallToAction Customizable call-to-action that this organizational entity wants to be associated with. No
locations array[LocationInfo] Locations of the entity. Yes
overviewPhotoV2 OrganizationCroppedImage Overview photo uploaded via Vector. The image used in the Overview tab on the organization's page. No
staffCountRange StaffCountRange Range of the number of staff associated with this entity. Value enums include:
  • SIZE_1
  • SIZE_2_TO_10
  • SIZE_11_TO_50
  • SIZE_51_TO_200
  • SIZE_201_TO_500
  • SIZE_501_TO_1000
  • SIZE_1001_TO_5000
  • SIZE_5001_TO_10000
  • SIZE_10001_OR_MORE
 No
organizationType OrganizationType Type of organization. Value enums include:
  • PUBLIC_COMPANY
  • EDUCATIONAL
  • SELF_EMPLOYED
  • GOVERNMENT_AGENCY
  • NON_PROFIT
  • SELF_OWNED
  • PRIVATELY_HELD
  • PARTNERSHIP
 No
organizationStatus OrganizationStatus Status of the organization. Value enums include:
  • OPERATING
  • OPERATING_SUBSIDIARY
  • REORGANIZING
  • OUT_OF_BUSINESS
  • ACQUIRED
 No
parentRelationship OrganizationParentRelationship The organization's relationship with its parent. No
schoolAttributes SchoolAttributes School-specific attributes of the organization. If this field exists, then this entity is a school. No
parentCareersUsed boolean Whether to use the careers data from this organization's parent organization to render the careers section of it's page. If there is no parent for this organization, this field will be set to false. Yes
companyAttributes CompanyAttributes Company-specific attributes of the organization. If this field exists, then this entity is a company. No
revenueRecords array[Revenue] Organization revenue records. Could be quarterly or yearly. Yes
partnerInfo PartnerInfo Information about the partner who provided all of the data for this organization. No
brandAttributes BrandAttributes Brand-specific attributes of the organization. If this field exists, then this entity is a brand. No
settings Settings Organization-specific settings, such as ads display setting. No
primaryOrganizationType PrimaryOrganizationType Defines the primary organization type of an organizational entity. Value enums include:
  • SCHOOL
  • BRAND
  • NONE
 No
organizationFieldStates OrganizationFieldStates Represents the state of fields in an Organization Entity. No
multiLocaleAnnouncements map[string, AttributedText] The map of Locale to announcement message of an organization. Each key is a Locale record converted to string format, with the language, country and variant separated by underscores. No
localizedAnnouncement AttributedText The locale-specific announcement of the organization. No
competitorOrganizationUrn](../pages-profiles/organizations.md)s arrayOrganizationUrn] Organizations that this organizational entity has selected to compare themselves against with regards to their public branding presence on LinkedIn (social activity, follower counts, etc) No
isArchived boolean Whether the organizational entity has been archived by an admin. No
industriesV2 array[IndustryUrn] The industries with industryV2 taxonomy data associated with the entity. No
leadGenFormEntryPoint LeadGenFormEntryPoint LeadGenForm entry point shown on the organization page. No
organizationalPage OrganizationalPageUrn OrganizationalPageUrn to represent this organization entity (i.e. Company/School/Showcase) page. No
customSpotlight CustomSpotlight Custom spotlight for the Page. No
Sub Schemas
AuditStamp
Field Format Description Required
time long Time stamp of when the resource/association/sub-resource moved into the specific lifecycle stage represented by this AuditEvent. No
actor URN The entity (e.g. a personUrn, organizationalPageUrn, etc) which will be credited for moving the resource/association/sub-resource into the specific lifecycle stage. It is also the one used to authorize the change. No
impersonator URN The entity which performs the change on behalf of the Actor and must be authorized to act as the Actor. No
OrganizationCroppedImage
Field Format Description Required
cropped Image The cropped Image. Yes
original Image The cropped Image. Yes
cropInfo Rectangle The cropping information defined by a rectangle in which the specified corner is the upper-left corner of the crop area Yes
Image
Field Format Description Required
status MediaStatus Status of an Asset. Value enums include:
  • PROCESSING
  • PROCESSING_FAILED
  • AVAILABLE
  • WAITING_UPLOAD
 Yes
downloadUrl String URL to download/view the media asset. No
downloadUrlExpiresAt long Milliseconds since the epoch (1970-01-01 00:00 UTC) when the identifier expires. No
Rectangle
Field Format Description Required
x int X coordinate of the corner. Yes
y int Y coordinate of the corner. Yes
width int Width of the rectangle. Yes
height int Height of the rectangle. Yes
Date
Field Format Description
day Integer Day represented in integer. Valid range from 1 to 31 depending on month.
month Integer Month represented in integer. Valid range from 1 to 12.
year Integer Year represented in integer.
LocaleTags
Field Format Description Required
tags array[String] Tags of the entity. Yes
locale Locale URL to download/view the media asset. Yes
Locale
Field Format Description Required
language String The Language field of Locale. No
country String The Country field of Locale. No
variant String The Variant field of Locale. No
PhoneNumber
Field Format Description Required
number String Formatted String of the PhoneNumber. No
extension String The extension field of PhoneNumber. No
OrganizationCallToAction
Field Format Description Required
ctaType String Verb of the message that should be conveyed. Value enums include:
  • VIEW_WEBSITE
  • SEE_JOBS
  • VIEW_CONTACT_INFO
  • LEARN_MORE
  • SIGN_UP
  • SUBSCRIBE
  • REGISTER
  • EMAIL_US
  • CALL_US
  • REQUEST_DEMO
  • DONATE
  • VOLUNTEER
  • VIEW_SERVICES_PAGES
  • BUY_PRODUCT
  • VISIT_PORTFOLIO
 Yes
redirectUrl String URL to redirect users to when they interact with this call to action. Yes
active boolean Whether or not this call to action should be active. Yes
LocationInfo
Field Format Description Required
address Address Address of the entity. No
locationType LocationType Type of this location. Value enums include:
  • HEADQUARTERS
  • OTHER
 Yes
staffCountRange StaffCountRange Range of the number of staff at this location. Value enums include:
  • SIZE_1
  • SIZE_2_TO_10
  • SIZE_11_TO_50
  • SIZE_51_TO_200
  • SIZE_201_TO_500
  • SIZE_501_TO_1000
  • SIZE_1001_TO_5000
  • SIZE_5001_TO_10000
  • SIZE_10001_OR_MORE
 No
description MultiLocaleString Description of this location. No
localizedDescription String The locale-specific description of the entity. No
phoneNumber1 PhoneNumber The primary phone number of the entity at this location. No
phoneNumber2 PhoneNumber The secondary phone number of the entity at this location. No
faxNumber PhoneNumber The fax number of the entity at this location. No
geoLocation GeoUrn GeoUrn for this location, maps to the most granular entity available based on country/region + postal code in the address field. No
streetAddressFieldState OrganizationFieldStateType It represents field state types used in the OrganizationFieldStates. Value enums include:
  • OPT_OUT
  • UNSET_OPT_OUT
 No
Address
Field Format Description Required
line1 String First line of this address. No
line2 String Second line of this address. No
line3 String Third line of this address. No
line4 String Fourth line of this address. No
city String City this address belongs to. No
geographicAreaType GeographicAreaType The type of the geographic area, State or Province. Value enums include:
  • GeographicAreaType_AUTO_GEN_UNKNOWN
  • GeographicAreaType_PROVINCE
  • GeographicAreaType_STATE
 No
geographicArea String State of the province this address belongs to. No
postalCode String Postal code of this address. No
country String Country this address belongs to. ISO 3166-2 2 Character Country Code No
latLong LatLong Geographical coordinates of the address. No
LatLong
Field Format Description Required
latitude float The latitude in decimal degrees. No
longitude float The longitude in decimal degrees. No
OrganizationParentRelationship
Field Format Description Required
parent OrganizationUrn](../pages-profiles/organizations.md) URN of the parent organization. Yes
relationshipStatus RelationshipStatus Status of the relationship. Value enums include:
  • ACTIVE
  • INACTIVE
 Yes
organizationRelationshipType OrganizationRelationshipType Type of relationship from child to parent organizations. Value enums include:
  • SUBSIDIARY
  • ACQUISITION
  • SCHOOL
  • BRAND
 Yes
employeesIncludedInParentOrganization boolean Whether to include this organization's employees into its parent organization's employees list. Yes
jobsIncludedInParentOrganization boolean Whether to include this organization's jobs into its parent organization's jobs list. Yes
SchoolAttributes
Field Format Description Required
yearLevel SchoolYearLevel Classification of the length of the institution's educational programs. Value enums include:
  • UNDER_TWO_YEAR
  • TWO_YEAR
  • FOUR_YEAR
 No
type SchoolType The type of institution. Value enums include:
  • PUBLIC
  • PRIVATE
  • PROFIT
 No
hierarchyClassification HierarchyClassification The classification for school hierarchy. Value enums include:
  • CONSORTIUM_SYSTEM
  • UNIVERSITY
  • INDEPENDENT_SCHOOL_COLLEGE_PROVIDER
  • REMOTE_CAMPUS
  • DISTANCE_LEARNING
 No
CompanyAttributes
Field Format Description Required
stocks array[Stock] The company's stocks. Applicable to public companies. Yes
Stock
Field Format Description Required
stockExchange String The stock exchange listing the stock, e.g. NYSE. Yes
stockSymbol String The stock symbol, e.g. MSFT. Yes
Revenue
Field Format Description Required
currencyCode String The currency code of revenue. No
endOn Date The end date of a time period when the revenue is collected. Yes
exactAmount BigDecimal The exact revenue amount represented in string as BigDecimal. e.g. "100" No
period RevenuePeriod The time period during which the revenue is collected - either quarterly or annually. Value enums include:
  • Q1
  • Q2
  • Q3
  • Q4
  • ANNUAL
 No
rangeAmount ClosedBigDecimalRange The revenue amount range, most likely inferred -- less preferred if exact amount exists. No
ClosedBigDecimalRange
Field Format Description Required
start String Represents the inclusive (greater than or equal) value in which to start the range. No
end String Represents the inclusive (less than or equal) value in which to end the range. No
PartnerInfo
Field Format Description Required
partnerUrl String Link to partner's website. Yes
sourceCode String Code of source(partner). Ex. companies_house, orb, etc. Yes
BrandAttributes
Field Format Description Required
siblingBrandsShown boolean Whether to display sibling brands on it's page, If no value provided then default is false. Yes
Settings
Field Format Description Required
adSetting AdSetting Setting for displaying ads in an organization page. Value enums include:
  • NO_ADS
  • NO_SECOND_ADS
  • ALLOW_ADS
 Yes
employeeExperienceSettingsV2 EmployeeExperienceSettingsV2 Settings for the Employee Experience tab of an organization page. No
premiumPageSettings PremiumPageSettings Settings for Premium Page features. Optional for backward compatibility and when the page did not specify any premium settings. No
EmployeeExperienceSettingsV2
Field Format Description Required
trendingContentVisibility EmployeeExperienceContentVisibility Visibility settings for trending content. This field could be set by admins, default is ALL_EMPLOYEES. Value enums include:
  • NONE
  • VERIFIED_EMPLOYEES
  • ALL_EMPLOYEES
 Yes
myCompanyEmployeeVerificationRequired boolean This setting will enable admins to require that members verify that they are employees of this organization prior to accessing the MyCompany tab. If this field is null, it will be interpreted as false for backwards compatibility. No
PremiumPageSettings
Field Format Description Required
enhancedCtaVisibility boolean Whether or not the organization's call to action has enhanced visibility enabled. Yes
automaticInvites boolean Whether or not the organization has automatic invites enabled. No
OrganizationFieldStates
Field Format Description Required
OrganizationFieldStates OrganizationFieldStateType State of website field. Value enums include:
  • OPT_OUT
  • UNSET_OPT_OUT
 No
AttributedText
Field Format Description Required
text String The text content that may be attributed. Yes
inferredLocale String The locale that may have be inferred for this text. This value would be null if the local inference was not possible or successful Yes
attributes array[Attribute] User generated attributes in the text Yes
Attribute
Field Format Description Required
start int Starting position of the range within the referenced ordered collection. Yes
length int The length of the range within the referenced ordered collection. Yes
value union[MemberAttributedEntity,CompanyAttributedEntity,SchoolAttributedEntity,HyperlinkAttributedEntity,ImportanceAttributedEntity,SeatAttributedEntity,HashtagAttributedEntity,BoldAttributedEntity,OrganizationalPageAttributedEntity] The value of the attribute that applies to given range. MemberAttributedEntity marks a piece of text as a member profile. SchoolAttributedEntity marks a piece of text as a school profile. HyperlinkAttributedEntity marks a piece of text as a hyperlink. ImportanceAttributedEntity marks a piece of text as important, which needs to be emphasized. SeatAttributedEntity marks a piece of text as a seat profile. HashtagAttributedEntity marks a piece of text as a hashtag URN. BoldAttributedEntity marks a piece of text as strong/bold. OrganizationalPageAttributedEntity marks a piece of text as an Organizational Page. Yes
CompanyAttributedEntity
Field Format Description Required
company CompanyUrn Marks a piece of text as a company profile. This is used for @mentions of companies Yes
MemberAttributedEntity
Field Format Description Required
member MemberUrn The member entity URN Yes
SchoolAttributedEntity
Field Format Description Required
school SchoolUrn The school entity URN Yes
HyperlinkAttributedEntity
Field Format Description Required
url String The destination URL Yes
SeatAttributedEntity
Field Format Description Required
seat SeatUrn The seat entity URN Yes
HashtagAttributedEntity
Field Format Description Required
hashtag HashtagUrn The hashtag entity URN Yes
OrganizationalPageAttributedEntity
Field Format Description Required
organizationalPage OrganizationalPageUrn The organizational page entity URN. Yes
LeadGenFormEntryPoint
Field Format Description Required
ctaType LeadGenFormEntryPointCallToActionType Options for different CTA types shown in the entry point. They represent different types of inquiries for collecting leads through LeadGenForm. Value enums include:
  • CONTACT_SALES
  • REQUEST_DEMO
  • START_FREE_TRIAL
  • REQUEST_MORE_INFO
  • GET_STARTED
 Yes
headline String Headline of the entry point. Yes
body String Body of the entry point. Yes
visible boolean Whether or not the entry point is visible on the organization page. Default is false Yes
leadGenFormUrn VersionedLeadGenFormUrn URN that references the LeadGenForm that will be rendered from the entry point. Yes
CustomSpotlight
Field Format Description Required
visible boolean Whether or not to show the organization's custom spotlight in the top card. Yes
image OrganizationCroppedImage The image for the spotlight that the user uploaded. No
content MultiLocaleString The content of the spotlight to render in the organization's top card. No
localizedContent String The locale-specific content of the spotlight to render in the organization's top card. No

Retrieve Organizations Data

GET

Sample Request

GET https://api.linkedin.com/rest/dmaOrganizations/{ID}?locale=(language:en,country:US)

Sample Response

{
  "competitorOrganizationUrn](../pages-profiles/organizations.md)s": [
    "urn:li:organization:10334",
    "urn:li:organization:1234",
    "urn:li:organization:5866",
    "urn:li:organization:1663",
    "urn:li:organization:398439",
    "urn:li:organization:2384",
    "urn:li:organization:123",
    "urn:li:organization:10515",
    "urn:li:organization:12683"
  ],
  "description": {
    "localized": {
      "fr_FR": "french tagline",
      "en_US": "Extra cool just became even cooler!"
    },
    "preferredLocale": {
      "country": "US",
      "language": "en"
    }
  },
  "industriesV2": ["urn:li:industry:3132"],
  "callToAction": {
    "active": true,
    "redirectUrl": "http://extracoolinc.com",
    "ctaType": "LEARN_MORE"
  },
  "alternativeNames": [],
  "specialties": [
    {
      "locale": {
        "country": "US",
        "language": "en"
      },
      "tags": ["Advertising", "Dog Walking", "Manufacturing"]
    }
  ],
  "staffCountRange": "SIZE_1001_TO_5000",
  "localizedSpecialties": ["Advertising", "Dog Walking", "Manufacturing"],
  "organizationalPage": "urn:li:organizationalPage:123456",
  "primaryOrganizationType": "NONE",
  "id": 10002687,
  "localizedDescription": "Extra cool just became even cooler!",
  "autoCreated": false,
  "logoV2": {
    "cropped": {
      "downloadUrl": "https://media.licdn.com/dms/image/D4E0BAQFAdgjPA/company-logo_400_400/0/1702510174144?e=1710374400&v=beta&t=4XsKJoerqIOlIQjHp_vA9F-lUg9mIscCbVvcK_1CqH4",
      "downloadUrlExpiresAt": 1710374400000,
      "status": "AVAILABLE"
    },
    "cropInfo": {
      "x": 0,
      "width": 0,
      "y": 0,
      "height": 0
    },
    "original": {
      "downloadUrl": "https://media.licdn.com/dms/image/D4E0BAQFAdgGjPA/company-logo_400_400/0/1702510174144?e=1710374400&v=beta&t=4XsKJoerqIOlIQjHp_vA9F-lUg9mIscCbVvcK_1CqH4",
      "downloadUrlExpiresAt": 17103744000,
      "status": "AVAILABLE"
    }
  },
  "vanityName": "xtrakewl",
  "settings": {
    "employeeExperienceSettingsV2": {
      "myCompanyEmployeeVerificationRequired": true,
      "trendingContentVisibility": "ALL_EMPLOYEES"
    },
    "premiumPageSettings": {
      "enhancedCtaVisibility": true
    },
    "adSetting": "ALLOW_ADS"
  },
  "localizedName": "Extra Cool Inc.",
  "foundedOn": {
    "year": 2001
  },
  "created": {
    "actor": "urn:li:person:syasdD",
    "time": 1518028624160
  },
  "localizedTagline": "This is the tag line!",
  "organizationFieldStates": {
    "websiteFieldState": "OPT_OUT"
  },
  "lastModifiedByAdmin": {
    "actor": "urn:li:person:syabD",
    "time": 1702532973401
  },
  "primaryPhoneNumber": {
    "number": "8001231234"
  },
  "coverPhotoV2": {
    "cropped": {
      "downloadUrl": "https://media.licdn.com/dms/image/D4E3DAQHuFNSw/image-scale_191_1128/0/1702355879760/xtrakewl_cover?e=1703156400&v=beta&t=WYz7oyE8sUROficYSxEb987Omp29BqD14O6ADdhAWkQ",
      "downloadUrlExpiresAt": 1703156400000,
      "status": "AVAILABLE"
    },
    "cropInfo": {
      "x": 0,
      "width": 1128,
      "y": 0,
      "height": 191
    },
    "original": {
      "downloadUrl": "https://media.licdn.com/dms/image/D4E1BAQEfIDrA/company-background_10000/0/1702355879806/xtrakewl_cover?e=1703156400&v=beta&t=jCfDzr4z4eITZgC0s7NCs4W0zX-Q_ib-unGnIAE7Z9M",
      "downloadUrlExpiresAt": 1703156400000,
      "status": "AVAILABLE"
    }
  },
  "defaultLocale": {
    "country": "US",
    "language": "en"
  },
  "organizationType": "PRIVATELY_HELD",
  "leadGenFormEntryPoint": {
    "visible": true,
    "ctaType": "CONTACT_SALES",
    "body": "Brownie oat cake sesame snaps jujubes cake apple pie. I lovecake I love toffee chocolate cake I love jelly beans gummi bears. Tiramisu tart chocolate liquorice croissant sweet cotton candy powder",
    "headline": "Brownie oat cake sesame snaps jujubessssssssss",
    "leadGenFormUrn": "urn:li:versionedLeadGenForm:(urn:li:leadGenForm:6907010204,1)"
  },
  "entityStatus": "ACTIVE",
  "name": {
    "localized": {
      "en_US": "Extra Cool Inc."
    },
    "preferredLocale": {
      "country": "US",
      "language": "en"
    }
  },
  "tagline": {
    "localized": {
      "en_US": "This is the tag line!"
    },
    "preferredLocale": {
      "country": "US",
      "language": "en"
    }
  },
  "parentCareersUsed": false,
  "locations": [
    {
      "address": {
        "geographicArea": "California",
        "country": "US",
        "city": "Los Angeles",
        "line1": "60000 Cool Blvd",
        "postalCode": "90001"
      },
      "geoLocation": "urn:li:geo:10001",
      "staffCountRange": "SIZE_1",
      "description": {
        "localized": {
          "en_US": "mine"
        },
        "preferredLocale": {
          "country": "US",
          "language": "en"
        }
      },
      "locationType": "HEADQUARTERS",
      "localizedDescription": "mine",
      "streetAddressFieldState": "UNSET_OPT_OUT"
    }
  ],
  "revenueRecords": [],
  "lastModified": {
    "actor": "urn:li:person:syabD",
    "time": 1702532973401
  }
}

Parameters

Field Name Format Description Required Example
locale Locale Used for retrieving localized fields. If unspecified, then the default locale of each product will be used. No locale=(language:en,country:US)

BATCH_GET

Sample Request

GET https://api.linkedin.com/rest/dmaOrganizations?ids=List(ID_1,ID_2)&locale=(language:en,country:US)

Sample Response

{
  "results": {
    "10002687": {
      "competitorOrganizationUrn](../pages-profiles/organizations.md)s": [
        "urn:li:organization:132667",
        "urn:li:organization:11231",
        "urn:li:organization:304236",
        "urn:li:organization:1673",
        "urn:li:organization:32440",
        "urn:li:organization:22303",
        "urn:li:organization:41234",
        "urn:li:organization:104315",
        "urn:li:organization:10683"
      ],
      "description": {
        "localized": {
          "fr_FR": "french tagline",
          "en_US": "Extra cool just became even cooler!"
        },
        "preferredLocale": {
          "country": "US",
          "language": "en"
        }
      },
      "industriesV2": ["urn:li:industry:3132"],
      "callToAction": {
        "active": true,
        "redirectUrl": "http://extracoolinc.com",
        "ctaType": "LEARN_MORE"
      },
      "alternativeNames": [],
      "specialties": [
        {
          "locale": {
            "country": "US",
            "language": "en"
          },
          "tags": ["Advertising", "Dog Walking", "Manufacturing"]
        }
      ],
      "staffCountRange": "SIZE_1001_TO_5000",
      "localizedSpecialties": ["Advertising", "Dog Walking", "Manufacturing"],
      "organizationalPage": "urn:li:organizationalPage:10002687",
      "primaryOrganizationType": "NONE",
      "id": 10002687,
      "localizedDescription": "Extra cool just became even cooler!",
      "autoCreated": false,
      "logoV2": {
        "cropped": {
          "downloadUrl": "https://media.licdn.com/dms/image/D4E0BAQFAuGjPA/company-logo_400_400/0/1702510174144?e=1710374400&v=beta&t=4XsKJoerqIOlIQjHp_vA9F-lUg9mIscCbVvcK_1CqH4",
          "downloadUrlExpiresAt": 1710374400000,
          "status": "AVAILABLE"
        },
        "cropInfo": {
          "x": 0,
          "width": 0,
          "y": 0,
          "height": 0
        },
        "original": {
          "downloadUrl": "https://media.licdn.com/dms/image/D4E0BAQFAduGjPA/company-logo_400_400/0/1702510174144?e=1710374400&v=beta&t=4XsKJoerqIOlIQjHp_vA9F-lUg9mIscCbVvcK_1CqH4",
          "downloadUrlExpiresAt": 1710374400000,
          "status": "AVAILABLE"
        }
      },
      "vanityName": "xtrakewl",
      "settings": {
        "employeeExperienceSettingsV2": {
          "myCompanyEmployeeVerificationRequired": true,
          "trendingContentVisibility": "ALL_EMPLOYEES"
        },
        "premiumPageSettings": {
          "enhancedCtaVisibility": true
        },
        "adSetting": "ALLOW_ADS"
      },
      "localizedName": "Extra Cool Inc.",
      "foundedOn": {
        "year": 2001
      },
      "created": {
        "actor": "urn:li:person:syabss",
        "time": 1518028624160
      },
      "localizedTagline": "This is the tag line!",
      "organizationFieldStates": {
        "websiteFieldState": "OPT_OUT"
      },
      "lastModifiedByAdmin": {
        "actor": "urn:li:person:syabss",
        "time": 1702532973401
      },
      "primaryPhoneNumber": {
        "number": "8001231234"
      },
      "coverPhotoV2": {
        "cropped": {
          "downloadUrl": "https://media.licdn.com/dms/image/D4E3DAQHukh0NSw/image-scale_191_1128/0/1702355879760/xtrakewl_cover?e=1703156400&v=beta&t=WYz7oyE8sUROficYSxEb987Omp29BqD14O6ADdhAWkQ",
          "downloadUrlExpiresAt": 1703156400000,
          "status": "AVAILABLE"
        },
        "cropInfo": {
          "x": 0,
          "width": 1128,
          "y": 0,
          "height": 191
        },
        "original": {
          "downloadUrl": "https://media.licdn.com/dms/image/D4E1BAQEfI8m6DrA/company-background_10000/0/1702355879806/xtrakewl_cover?e=1703156400&v=beta&t=jCfDzr4z4eITZgC0s7NCs4W0zX-Q_ib-unGnIAE7Z9M",
          "downloadUrlExpiresAt": 1703156400000,
          "status": "AVAILABLE"
        }
      },
      "defaultLocale": {
        "country": "US",
        "language": "en"
      },
      "organizationType": "PRIVATELY_HELD",
      "leadGenFormEntryPoint": {
        "visible": true,
        "ctaType": "CONTACT_SALES",
        "body": "Brownie oat cake sesame snaps jujubes cake apple pie. I lovecake I love toffee chocolate cake I love jelly beans gummi bears. Tiramisu tart chocolate liquorice croissant sweet cotton candy powder",
        "headline": "Brownie oat cake sesame snaps jujubessssssssss",
        "leadGenFormUrn": "urn:li:versionedLeadGenForm:(urn:li:leadGenForm:6907010202353188864,1)"
      },
      "entityStatus": "ACTIVE",
      "name": {
        "localized": {
          "en_US": "Extra Cool Inc."
        },
        "preferredLocale": {
          "country": "US",
          "language": "en"
        }
      },
      "tagline": {
        "localized": {
          "en_US": "This is the tag line!"
        },
        "preferredLocale": {
          "country": "US",
          "language": "en"
        }
      },
      "parentCareersUsed": false,
      "locations": [
        {
          "address": {
            "geographicArea": "California",
            "country": "US",
            "city": "Los Angeles",
            "line1": "60000 Cool Blvd",
            "postalCode": "90001"
          },
          "geoLocation": "urn:li:geo:101308755",
          "staffCountRange": "SIZE_1",
          "description": {
            "localized": {
              "en_US": "mine"
            },
            "preferredLocale": {
              "country": "US",
              "language": "en"
            }
          },
          "locationType": "HEADQUARTERS",
          "localizedDescription": "mine",
          "streetAddressFieldState": "UNSET_OPT_OUT"
        }
      ],
      "revenueRecords": [],
      "lastModified": {
        "actor": "urn:li:person:syabss",
        "time": 1702532973401
      }
    },
    "19096789": {
      "competitorOrganizationUrn](../pages-profiles/organizations.md)s": ["urn:li:organization:24422"],
      "description": {
        "localized": {
          "en_US": "- Hier können Sie eine Beschreibung Ihres Unternehmens einfügen - 123444"
        },
        "preferredLocale": {
          "country": "US",
          "language": "en"
        }
      },
      "industriesV2": ["urn:li:industry:118"],
      "callToAction": {
        "active": true,
        "redirectUrl": "https://www.linkedin.com",
        "ctaType": "VIEW_CONTACT_INFO"
      },
      "alternativeNames": [],
      "specialties": [
        {
          "locale": {
            "country": "US",
            "language": "en"
          },
          "tags": ["Advertisting"]
        }
      ],
      "parentRelationship": {
        "jobsIncludedInParentOrganization": false,
        "organizationRelationshipType": "SUBSIDIARY",
        "relationshipStatus": "INACTIVE",
        "parent": "urn:li:organization:79617",
        "employeesIncludedInParentOrganization": true
      },
      "staffCountRange": "SIZE_201_TO_500",
      "localizedSpecialties": ["Advertisting"],
      "organizationalPage": "urn:li:organizationalPage:1954649",
      "primaryOrganizationType": "NONE",
      "id": 19096789,
      "localizedDescription": "- Hier können Sie eine Beschreibung Ihres Unternehmens einfügen - 123444",
      "autoCreated": false,
      "localizedWebsite": "www.beispiel.com",
      "logoV2": {
        "cropped": {
          "downloadUrl": "https://media.licdn.com/dms/image/D560BAQGu0VSvZk58PA/company-logo_400_400/0/1701892954142/product_marketplacehj_logo?e=1710374400&v=beta&t=z8gZP2-oECJolIZYjGwm7WsqFzAED_a-voLr2p8KrrY",
          "downloadUrlExpiresAt": 1710374400000,
          "status": "AVAILABLE"
        },
        "cropInfo": {
          "x": 0,
          "width": 0,
          "y": 0,
          "height": 0
        },
        "original": {
          "downloadUrl": "https://media.licdn.com/dms/image/D560BAQGu0VSvZk58PA/company-logo_400_400/0/1701892954142/product_marketplacehj_logo?e=1710374400&v=beta&t=z8gZP2-oECJolIZYjGwm7WsqFzAED_a-voLr2p8KrrY",
          "downloadUrlExpiresAt": 1710374400000,
          "status": "AVAILABLE"
        }
      },
      "vanityName": "product-marketplacehj",
      "settings": {
        "premiumPageSettings": {
          "enhancedCtaVisibility": true
        },
        "adSetting": "NO_ADS"
      },
      "localizedName": "Flexis",
      "website": {
        "localized": {
          "en_US": "www.beispiel.com"
        },
        "preferredLocale": {
          "country": "US",
          "language": "en"
        }
      },
      "foundedOn": {
        "year": 2015
      },
      "created": {
        "actor": "urn:li:person:syabss",
        "time": 1553710828378
      },
      "localizedTagline": "Page12345789",
      "organizationFieldStates": {
        "websiteFieldState": "UNSET_OPT_OUT"
      },
      "lastModifiedByAdmin": {
        "actor": "urn:li:person:syabss",
        "time": 1702532347191
      },
      "primaryPhoneNumber": {
        "number": "123456"
      },
      "defaultLocale": {
        "country": "US",
        "language": "en"
      },
      "organizationType": "PRIVATELY_HELD",
      "leadGenFormEntryPoint": {
        "visible": false,
        "ctaType": "REQUEST_DEMO",
        "body": "Let members know what to expect after",
        "headline": "Lead gen form title2",
        "leadGenFormUrn": "urn:li:versionedLeadGenForm:(urn:li:leadGenForm:12345,1)"
      },
      "entityStatus": "ACTIVE",
      "name": {
        "localized": {
          "it_IT": "Today Action Test Page1",
          "en_US": "Flexis",
          "da_DK": "Today Action Test Page1",
          "fa_IR": "Today Action Test",
          "hi_IN": "Today Action1",
          "cs_CZ": "CZ Product Marketplace | A Marketplace for Products 1",
          "ar_AE": "Today Action Test Page1",
          "in_ID": "Today Action Test Page1",
          "de_DE": "German Product Marketplace | A Marketplace for Products 1"
        },
        "preferredLocale": {
          "country": "US",
          "language": "en"
        }
      },
      "tagline": {
        "localized": {
          "en_US": "Page12345789"
        },
        "preferredLocale": {
          "country": "US",
          "language": "en"
        }
      },
      "parentCareersUsed": false,
      "pinnedPost": "urn:li:activity:714053",
      "locations": [
        {
          "description": {
            "localized": {
              "en_US": "Maria"
            },
            "preferredLocale": {
              "country": "US",
              "language": "en"
            }
          },
          "locationType": "HEADQUARTERS",
          "address": {
            "geographicArea": "California",
            "country": "US",
            "city": "Sunnyvale",
            "line1": "644 Morse Ave",
            "postalCode": "Sunnyvale"
          },
          "localizedDescription": "Maria",
          "streetAddressFieldState": "UNSET_OPT_OUT",
          "geoLocation": "urn:li:geo:104119"
        }
      ],
      "revenueRecords": [],
      "lastModified": {
        "actor": "urn:li:person:syabss",
        "time": 1702532347191
      }
    }
  },
  "statuses": {
    "10002687": 200,
    "19096789": 200
  },
  "errors": {}
}

Parameters

Field Name Format Description Required Example
ids List(ID_1,ID_2) List of Organization ids to query for Yes ids=List(ID_1, ID_2, ...)
locale Locale Used for retrieving localized fields. If unspecified, then the default locale of each product will be used. No locale=(language:en,country:US)

FINDER parentOrganization

Sample Request

GET https://api.linkedin.com/rest/dmaOrganizations?q=parentOrganization&parent=URN%3Ali%3Aorganization%3A{ID}

Sample Response

{
  "paging": {
    "start": 0,
    "count": 10,
    "links": []
  },
  "elements": [
    {
      "competitorOrganizationUrn](../pages-profiles/organizations.md)s": [
        "urn:li:organization:379211",
        "urn:li:organization:24220"
      ],
      "industriesV2": ["urn:li:industry:1232"],
      "alternativeNames": [],
      "specialties": [],
      "parentRelationship": {
        "jobsIncludedInParentOrganization": false,
        "organizationRelationshipType": "BRAND",
        "relationshipStatus": "ACTIVE",
        "parent": "urn:li:organization:10123",
        "employeesIncludedInParentOrganization": false
      },
      "localizedSpecialties": [],
      "organizationalPage": "urn:li:organizationalPage:12345",
      "primaryOrganizationType": "BRAND",
      "id": 89625314,
      "autoCreated": false,
      "localizedWebsite": "www.extracool-showcase.net",
      "logoV2": {
        "cropped": {
          "downloadUrl": "https://media.licdn.com/dms/image/C4E0BAQGem2d8w/company-logo_400_400/0/1668483281036?e=1710374400&v=beta&t=4rFv82rZa56xVYhVThNIBNCPvQbu4kFRKog6zOHmw8A",
          "downloadUrlExpiresAt": 1710374400000,
          "status": "AVAILABLE"
        },
        "cropInfo": {
          "x": 0,
          "width": 0,
          "y": 0,
          "height": 0
        },
        "original": {
          "downloadUrl": "https://media.licdn.com/dms/image/C4E0BakY8em2d8w/company-logo_400_400/0/1668483281036?e=1710374400&v=beta&t=4rFv82rZa56xVYhVThNIBNCPvQbu4kFRKog6zOHmw8A",
          "downloadUrlExpiresAt": 1710374400000,
          "status": "AVAILABLE"
        }
      },
      "vanityName": "extra-cool-showcase-page",
      "localizedName": "Extra Cool - Showcase Page",
      "website": {
        "localized": {
          "en_US": "www.extracool-showcase.net"
        },
        "preferredLocale": {
          "country": "US",
          "language": "en"
        }
      },
      "created": {
        "actor": "urn:li:person:sskjdbss",
        "time": 1668483287087
      },
      "organizationFieldStates": {
        "websiteFieldState": "UNSET_OPT_OUT"
      },
      "lastModifiedByAdmin": {
        "actor": "urn:li:person:sskjdbss",
        "time": 1686688246063
      },
      "brandAttributes": {
        "siblingBrandsShown": false
      },
      "defaultLocale": {
        "country": "US",
        "language": "en"
      },
      "entityStatus": "ACTIVE",
      "name": {
        "localized": {
          "en_US": "Extra Cool - Showcase Page"
        },
        "preferredLocale": {
          "country": "US",
          "language": "en"
        }
      },
      "parentCareersUsed": false,
      "locations": [],
      "revenueRecords": [],
      "lastModified": {
        "actor": "urn:li:person:sskjdbss",
        "time": 1692715587768
      }
    }
  ]
}

Parameters

Field Name Format Description Required Example
q String Name of the finder function to retrieve data from. Finder Name: parentOrganization Yes q=parentOrganization
parent String The parent organization to query child organizations by. Yes parent=urn:li:organization:123

FINDER vanityName

Sample Request

GET https://api.linkedin.com/rest/dmaOrganizations?q=vanityName&vanityName=xyz

Sample Response

{
  "paging": {
    "start": 0,
    "count": 10,
    "links": []
  },
  "elements": [
    {
      "competitorOrganizationUrn](../pages-profiles/organizations.md)s": [
        "urn:li:organization:1087",
        "urn:li:organization:1111",
        "urn:li:organization:39846",
        "urn:li:organization:1693",
        "urn:li:organization:32000",
        "urn:li:organization:9903",
        "urn:li:organization:614",
        "urn:li:organization:109915",
        "urn:li:organization:108723683"
      ],
      "description": {
        "localized": {
          "fr_FR": "french tagline",
          "en_US": "Extra cool just became even cooler!"
        },
        "preferredLocale": {
          "country": "US",
          "language": "en"
        }
      },
      "industriesV2": ["urn:li:industry:3122"],
      "callToAction": {
        "active": true,
        "redirectUrl": "http://extracoolinc.com",
        "ctaType": "LEARN_MORE"
      },
      "alternativeNames": [],
      "specialties": [
        {
          "locale": {
            "country": "US",
            "language": "en"
          },
          "tags": ["Advertising", "Dog Walking", "Manufacturing"]
        }
      ],
      "staffCountRange": "SIZE_1001_TO_5000",
      "localizedSpecialties": ["Advertising", "Dog Walking", "Manufacturing"],
      "organizationalPage": "urn:li:organizationalPage:13687",
      "primaryOrganizationType": "NONE",
      "id": 10002687,
      "localizedDescription": "Extra cool just became even cooler!",
      "autoCreated": false,
      "logoV2": {
        "cropped": {
          "downloadUrl": "https://media.licdn.com/dms/image/D4E0BAQFA1uGjPA/company-logo_400_400/0/1702510174144?e=1710374400&v=beta&t=4XsKJoerqIOlIQjHp_vA9F-lUg9mIscCbVvcK_1CqH4",
          "downloadUrlExpiresAt": 1710374400000,
          "status": "AVAILABLE"
        },
        "cropInfo": {
          "x": 0,
          "width": 0,
          "y": 0,
          "height": 0
        },
        "original": {
          "downloadUrl": "https://media.licdn.com/dms/image/D4E0BAQuGjPA/company-logo_400_400/0/1702510174144?e=1710374400&v=beta&t=4XsKJoerqIOlIQjHp_vA9F-lUg9mIscCbVvcK_1CqH4",
          "downloadUrlExpiresAt": 1710374400000,
          "status": "AVAILABLE"
        }
      },
      "vanityName": "xtrakewl",
      "settings": {
        "employeeExperienceSettingsV2": {
          "myCompanyEmployeeVerificationRequired": true,
          "trendingContentVisibility": "ALL_EMPLOYEES"
        },
        "premiumPageSettings": {
          "enhancedCtaVisibility": true
        },
        "adSetting": "ALLOW_ADS"
      },
      "localizedName": "Extra Cool Inc.",
      "foundedOn": {
        "year": 2001
      },
      "created": {
        "actor": "urn:li:person:sasJgsy",
        "time": 1518028624160
      },
      "localizedTagline": "This is the tag line!",
      "organizationFieldStates": {
        "websiteFieldState": "OPT_OUT"
      },
      "lastModifiedByAdmin": {
        "actor": "urn:li:person:sasJgsy",
        "time": 1702532973401
      },
      "primaryPhoneNumber": {
        "number": "8001231234"
      },
      "coverPhotoV2": {
        "cropped": {
          "downloadUrl": "https://media.licdn.com/dms/image/D4E3DAQdkh0NSw/image-scale_191_1128/0/1702355879760/xtrakewl_cover?e=1703160000&v=beta&t=vi968kocnvgj69eY1Qip6Y8TfAyH4YoynuBLXtY0Z34",
          "downloadUrlExpiresAt": 1703160000000,
          "status": "AVAILABLE"
        },
        "cropInfo": {
          "x": 0,
          "width": 1128,
          "y": 0,
          "height": 191
        },
        "original": {
          "downloadUrl": "https://media.licdn.com/dms/image/D4E1BAQEfI8mrA/company-background_10000/0/1702355879806/xtrakewl_cover?e=1703160000&v=beta&t=cWi_IqPiq6qpcDs14zT_E3-dC9cFb1RJ18pVHigaIUU",
          "downloadUrlExpiresAt": 1703160000000,
          "status": "AVAILABLE"
        }
      },
      "defaultLocale": {
        "country": "US",
        "language": "en"
      },
      "organizationType": "PRIVATELY_HELD",
      "leadGenFormEntryPoint": {
        "visible": true,
        "ctaType": "CONTACT_SALES",
        "body": "Brownie oat cake sesame snaps jujubes cake apple pie. I lovecake I love toffee chocolate cake I love jelly beans gummi bears. Tiramisu tart chocolate liquorice croissant sweet cotton candy powder",
        "headline": "Brownie oat cake sesame snaps jujubessssssssss",
        "leadGenFormUrn": "urn:li:versionedLeadGenForm:(urn:li:leadGenForm:69070102023,1)"
      },
      "entityStatus": "ACTIVE",
      "name": {
        "localized": {
          "en_US": "Extra Cool Inc."
        },
        "preferredLocale": {
          "country": "US",
          "language": "en"
        }
      },
      "tagline": {
        "localized": {
          "en_US": "This is the tag line!"
        },
        "preferredLocale": {
          "country": "US",
          "language": "en"
        }
      },
      "parentCareersUsed": false,
      "locations": [
        {
          "address": {
            "geographicArea": "California",
            "country": "US",
            "city": "Los Angeles",
            "line1": "60000 Cool Blvd",
            "postalCode": "90001"
          },
          "geoLocation": "urn:li:geo:1234",
          "staffCountRange": "SIZE_1",
          "description": {
            "localized": {
              "en_US": "mine"
            },
            "preferredLocale": {
              "country": "US",
              "language": "en"
            }
          },
          "locationType": "HEADQUARTERS",
          "localizedDescription": "mine",
          "streetAddressFieldState": "UNSET_OPT_OUT"
        }
      ],
      "revenueRecords": [],
      "lastModified": {
        "actor": "urn:li:person:sasJgsy",
        "time": 1702532973401
      }
    }
  ]
}

Parameters

Field Name Format Description Required Example
q String Name of the finder function to retrieve data from. Finder Name: vanityName Yes q=vanityName
vanityName String Vanity name to query organizations by. Yes vanityName=test

FINDER emailDomain

Sample Request

GET https://api.linkedin.com/rest/dmaOrganizations?q=emailDomain&emailDomain=abc.com

Sample Response

{
  "paging": {
    "start": 0,
    "count": 10,
    "links": []
  },
  "elements": [
    {
      "competitorOrganizationUrn](../pages-profiles/organizations.md)s": [
        "urn:li:organization:1087",
        "urn:li:organization:1111",
        "urn:li:organization:9903",
        "urn:li:organization:614",
        "urn:li:organization:109915",
        "urn:li:organization:108723683"
      ],
      "description": {
        "localized": {
          "fr_FR": "french tagline",
          "en_US": "Extra cool just became even cooler!"
        },
        "preferredLocale": {
          "country": "US",
          "language": "en"
        }
      },
      "industriesV2": ["urn:li:industry:3122"],
      "callToAction": {
        "active": true,
        "redirectUrl": "http://extracoolinc.com",
        "ctaType": "LEARN_MORE"
      },
      "alternativeNames": [],
      "specialties": [
        {
          "locale": {
            "country": "US",
            "language": "en"
          },
          "tags": ["Advertising", "Dog Walking", "Manufacturing"]
        }
      ],
      "staffCountRange": "SIZE_1001_TO_5000",
      "localizedSpecialties": ["Advertising", "Dog Walking", "Manufacturing"],
      "organizationalPage": "urn:li:organizationalPage:13687",
      "primaryOrganizationType": "NONE",
      "id": 10002687,
      "localizedDescription": "Extra cool just became even cooler!",
      "autoCreated": false,
      "logoV2": {
        "cropped": {
          "downloadUrl": "https://media.licdn.com/dms/image/D4E0BAQFA1uGjPA/company-logo_400_400/0/1702510174144?e=1710374400&v=beta&t=4XsKJoerqIOlIQjHp_vA9F-lUg9mIscCbVvcK_1CqH4",
          "downloadUrlExpiresAt": 1710374400000,
          "status": "AVAILABLE"
        },
        "cropInfo": {
          "x": 0,
          "width": 0,
          "y": 0,
          "height": 0
        },
        "original": {
          "downloadUrl": "https://media.licdn.com/dms/image/D4E0BAQuGjPA/company-logo_400_400/0/1702510174144?e=1710374400&v=beta&t=4XsKJoerqIOlIQjHp_vA9F-lUg9mIscCbVvcK_1CqH4",
          "downloadUrlExpiresAt": 1710374400000,
          "status": "AVAILABLE"
        }
      },
      "vanityName": "xtrakewl",
      "settings": {
        "employeeExperienceSettingsV2": {
          "myCompanyEmployeeVerificationRequired": true,
          "trendingContentVisibility": "ALL_EMPLOYEES"
        },
        "premiumPageSettings": {
          "enhancedCtaVisibility": true
        },
        "adSetting": "ALLOW_ADS"
      },
      "localizedName": "Extra Cool Inc.",
      "foundedOn": {
        "year": 2001
      },
      "created": {
        "actor": "urn:li:person:sasJgsy",
        "time": 1518028624160
      },
      "localizedTagline": "This is the tag line!",
      "organizationFieldStates": {
        "websiteFieldState": "OPT_OUT"
      },
      "lastModifiedByAdmin": {
        "actor": "urn:li:person:sasJgsy",
        "time": 1702532973401
      },
      "primaryPhoneNumber": {
        "number": "8001231234"
      },
      "coverPhotoV2": {
        "cropped": {
          "downloadUrl": "https://media.licdn.com/dms/image/D4E3DAQdkh0NSw/image-scale_191_1128/0/1702355879760/xtrakewl_cover?e=1703160000&v=beta&t=vi968kocnvgj69eY1Qip6Y8TfAyH4YoynuBLXtY0Z34",
          "downloadUrlExpiresAt": 1703160000000,
          "status": "AVAILABLE"
        },
        "cropInfo": {
          "x": 0,
          "width": 1128,
          "y": 0,
          "height": 191
        },
        "original": {
          "downloadUrl": "https://media.licdn.com/dms/image/D4E1BAQEfI8mrA/company-background_10000/0/1702355879806/xtrakewl_cover?e=1703160000&v=beta&t=cWi_IqPiq6qpcDs14zT_E3-dC9cFb1RJ18pVHigaIUU",
          "downloadUrlExpiresAt": 1703160000000,
          "status": "AVAILABLE"
        }
      },
      "defaultLocale": {
        "country": "US",
        "language": "en"
      },
      "organizationType": "PRIVATELY_HELD",
      "leadGenFormEntryPoint": {
        "visible": true,
        "ctaType": "CONTACT_SALES",
        "body": "Brownie oat cake sesame snaps jujubes cake apple pie. I lovecake I love toffee chocolate cake I love jelly beans gummi bears. Tiramisu tart chocolate liquorice croissant sweet cotton candy powder",
        "headline": "Brownie oat cake sesame snaps jujubessssssssss",
        "leadGenFormUrn": "urn:li:versionedLeadGenForm:(urn:li:leadGenForm:69070102023,1)"
      },
      "entityStatus": "ACTIVE",
      "name": {
        "localized": {
          "en_US": "Extra Cool Inc."
        },
        "preferredLocale": {
          "country": "US",
          "language": "en"
        }
      },
      "tagline": {
        "localized": {
          "en_US": "This is the tag line!"
        },
        "preferredLocale": {
          "country": "US",
          "language": "en"
        }
      },
      "parentCareersUsed": false,
      "locations": [
        {
          "address": {
            "geographicArea": "California",
            "country": "US",
            "city": "Los Angeles",
            "line1": "60000 Cool Blvd",
            "postalCode": "90001"
          },
          "geoLocation": "urn:li:geo:1234",
          "staffCountRange": "SIZE_1",
          "description": {
            "localized": {
              "en_US": "mine"
            },
            "preferredLocale": {
              "country": "US",
              "language": "en"
            }
          },
          "locationType": "HEADQUARTERS",
          "localizedDescription": "mine",
          "streetAddressFieldState": "UNSET_OPT_OUT"
        }
      ],
      "revenueRecords": [],
      "lastModified": {
        "actor": "urn:li:person:sasJgsy",
        "time": 1702532973401
      }
    }
  ]
}

Parameters

Field Name Format Description Required Example
q String Name of the finder function to retrieve data from. Finder Name: emailDomain Yes q=emailDomain
emailDomain String The email domain to query organizations by. Yes emailDomain=test

API Error Details

HTTP Status Code ERROR MESSAGE DESCRIPTION ERROR RESOLUTION
400 BAD_REQUEST Invalid request. Please verify the API input. Use a valid URL and parameters.
401 EMPTY_ACCESS_TOKEN Empty or expired OAuth2 access token. Use a valid member access token.
403 FORBIDDEN Access to the resource is forbidden. Please check your permissions for this resource. Make sure your developer application is provisioned with the required permissions.
404 NOT_FOUND Could not find entity. Verify the provided entity id is correct.
500 INTERNAL_SERVER_ERROR Server encountered an unexpected condition that prevented it from fulfilling the request. N/A
  • Last updated on