# Get lead forms GET https://services.leadconnectorhq.com/ad-publishing/linkedin/{accountId}/forms Retrieve LinkedIn lead gen forms for an ad account. By default each form is returned in full as a plain array; pass `projection` (comma-separated, dot-notation for nested fields) to return only the requested fields — any value outside the known field set is rejected. When `limit` is provided (max 100) the response is a paginated `{ leadForms, paging }` envelope; pass `pageToken` (from `paging.next`) to fetch the next batch. Deprecated: use GET /ad-publishing/linkedin/accounts/{accountId}/forms with header version: v4. ## Authentication Send `Authorization: Bearer ` using: - **Sub-Account token: OAuth access token or Private Integration Token.** Scopes: `adPublishing.readonly` ## Parameters ### Header Parameters | Name | Type | Required | Description | |------|------|----------|-------------| | `Version` | string | Yes | API Version | ### Path Parameters | Name | Type | Required | Description | |------|------|----------|-------------| | `accountId` | string | Yes | Account identifier | ### Query Parameters | Name | Type | Required | Description | |------|------|----------|-------------| | `locationId` | string | Yes | Location identifier | | `projection` | array | No | Fields to return on each lead form, comma-separated (e.g. ?projection=id,name,state,created,reviewInfo.reviewStatus). When set, only the requested fields are returned; any value outside the known field set is rejected. Nested fields use dot-notation (naming a parent like `reviewInfo` returns the whole object). Omit to receive the full form (including content.questions) as-is. | | `limit` | string | No | Page size for a paginated fetch (max 100). When set, the response is a { leadForms, paging } envelope instead of a plain array. | | `pageToken` | string | No | Opaque cursor for the next batch, taken from the previous response paging.next | ## OpenAPI Specification ```json { "openapi": "3.0.0", "info": { "title": "HighLevel API", "version": "2021-04-15" }, "servers": [ { "url": "https://services.leadconnectorhq.com" } ], "paths": { "/ad-publishing/linkedin/{accountId}/forms": { "get": { "summary": "Get lead forms", "operationId": "getLeadForms", "description": "Retrieve LinkedIn lead gen forms for an ad account. By default each form is returned in full as a plain array; pass `projection` (comma-separated, dot-notation for nested fields) to return only the requested fields — any value outside the known field set is rejected. When `limit` is provided (max 100) the response is a paginated `{ leadForms, paging }` envelope; pass `pageToken` (from `paging.next`) to fetch the next batch. Deprecated: use GET /ad-publishing/linkedin/accounts/{accountId}/forms with header version: v4.", "parameters": [ { "name": "Version", "in": "header", "description": "API Version", "required": true, "schema": { "type": "string", "enum": [ "2021-04-15" ] } }, { "name": "accountId", "required": true, "in": "path", "description": "Account identifier", "schema": { "example": "12345678", "type": "string" } }, { "name": "locationId", "required": true, "in": "query", "description": "Location identifier", "schema": { "example": "loc_abc123", "type": "string" } }, { "name": "projection", "required": false, "in": "query", "description": "Fields to return on each lead form, comma-separated (e.g. ?projection=id,name,state,created,reviewInfo.reviewStatus). When set, only the requested fields are returned; any value outside the known field set is rejected. Nested fields use dot-notation (naming a parent like `reviewInfo` returns the whole object). Omit to receive the full form (including content.questions) as-is.", "schema": { "example": [ "id", "name", "state", "created", "reviewInfo.reviewStatus" ], "type": "array", "items": { "type": "string", "enum": [ "id", "name", "state", "created", "lastModified", "versionId", "creationLocale", "owner", "reviewInfo", "reviewInfo.reviewStatus", "reviewInfo.rejectionReasons", "content", "content.headline", "content.questions", "content.legalInfo", "hiddenFields" ] } } }, { "name": "limit", "required": false, "in": "query", "description": "Page size for a paginated fetch (max 100). When set, the response is a { leadForms, paging } envelope instead of a plain array.", "schema": { "example": "100", "type": "string" } }, { "name": "pageToken", "required": false, "in": "query", "description": "Opaque cursor for the next batch, taken from the previous response paging.next", "schema": { "example": "100", "type": "string" } } ], "responses": { "200": { "description": "A plain array of lead forms (default), or a { leadForms, paging } envelope when `limit` is provided", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetLeadFormsResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BadRequestDTO" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnauthorizedDTO" } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnprocessableDTO" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalServerErrorDTO" } } } } }, "security": [ { "bearer": [ "adPublishing.readonly" ] } ] } } }, "components": { "securitySchemes": { "bearer": { "scheme": "bearer", "bearerFormat": "JWT", "name": "Authorization", "in": "header", "description": "Use the Access Token generated with user type as Sub-Account (OR) Private Integration Token of Sub-Account.", "type": "http" }, "Location-Access": { "scheme": "bearer", "bearerFormat": "JWT", "name": "Authorization", "in": "header", "description": "Use the Access Token generated with user type as Sub-Account (OR) Private Integration Token of Sub-Account.", "type": "http" }, "Location-Access-Only": { "scheme": "bearer", "bearerFormat": "JWT", "name": "Authorization", "in": "header", "description": "Use the Access Token generated with user type as Sub-Account.", "type": "http" }, "Agency-Access": { "scheme": "bearer", "bearerFormat": "JWT", "name": "Authorization", "in": "header", "description": "Use the Access Token generated with user type as Agency (OR) Private Integration Token of Agency.", "type": "http" }, "Agency-Access-Only": { "scheme": "bearer", "bearerFormat": "JWT", "name": "Authorization", "in": "header", "description": "Use the Access Token generated with user type as Agency.", "type": "http" } }, "schemas": { "GetLeadFormsResponse": { "oneOf": [ { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "number", "description": "Form id. Returned as a number.", "example": 1025914010 }, "name": { "type": "string", "description": "Form name", "example": "Q3 demand generation form" }, "state": { "type": "string", "description": "Form lifecycle state", "example": "PUBLISHED" }, "versionId": { "type": "number", "description": "Version of the form definition", "example": 1 }, "created": { "type": "number", "description": "When the form was created, epoch milliseconds", "example": 1787056838757 }, "lastModified": { "type": "number", "description": "When the form was last modified, epoch milliseconds", "example": 1787057842322 }, "creationLocale": { "description": "Locale the form was authored in", "example": { "country": "US", "language": "en" }, "allOf": [ { "type": "object", "properties": { "country": { "type": "string", "description": "Two-letter country code", "example": "US" }, "language": { "type": "string", "description": "Two-letter language code", "example": "en" } }, "required": [ "country", "language" ], "title": "LinkedInLocaleDTO" } ] }, "owner": { "description": "Account that owns the form", "example": { "sponsoredAccount": "urn:li:sponsoredAccount:556129919" }, "allOf": [ { "type": "object", "properties": { "sponsoredAccount": { "type": "string", "description": "Sponsored account URN that owns the form", "example": "urn:li:sponsoredAccount:556129919" } }, "required": [ "sponsoredAccount" ], "title": "LinkedInFormOwnerDTO" } ] }, "reviewInfo": { "description": "LinkedIn review outcome. Absent on a form that has just been created and not yet reviewed; present on reads.", "example": { "reviewStatus": "REJECTED", "rejectionReasons": [ "MISSING_PRIVACY_POLICY", "NONFUNCTIONAL_SITE" ], "lastUpdated": 1787057842315 }, "allOf": [ { "type": "object", "properties": { "reviewStatus": { "type": "string", "description": "Review outcome", "enum": [ "AUTO_APPROVED", "NEEDS_REVIEW", "REJECTED", "APPROVED" ], "example": "REJECTED" }, "rejectionReasons": { "description": "Why the form was rejected. Empty array when it was not.", "example": [ "MISSING_PRIVACY_POLICY", "NONFUNCTIONAL_SITE" ], "type": "array", "items": { "type": "string" } }, "lastUpdated": { "type": "number", "description": "When the review last changed, epoch milliseconds", "example": 1787057842315 } }, "required": [ "reviewStatus", "rejectionReasons", "lastUpdated" ], "title": "LinkedInFormReviewInfoDTO" } ] }, "hiddenFields": { "description": "Hidden fields submitted alongside the lead. Empty array when none.", "example": [ { "name": "utm_source", "value": "linkedin" } ], "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "description": "Field name", "example": "utm_source" }, "value": { "type": "string", "description": "Field value submitted with the lead", "example": "linkedin" } }, "required": [ "name", "value" ], "title": "LinkedInFormHiddenFieldDTO" } }, "content": { "description": "Form definition", "example": { "headline": { "localized": { "en_US": "Hi there, good to see you here!" } }, "description": { "localized": { "en_US": "Hi there, good to see you here!" } }, "questions": [ { "questionId": 20711780444, "question": { "localized": { "en_US": "Hi there, good to see you here!" } }, "name": "lastName", "label": "Last name", "responseRequired": true, "responseEditable": true, "predefinedField": "LAST_NAME", "questionDetails": { "textQuestionDetails": { "maxResponseLength": 300 }, "multipleChoiceQuestionDetails": { "options": [ { "id": 0, "label": "Option 1", "text": { "localized": { "en_US": "Hi there, good to see you here!" } } } ] } } } ], "postSubmissionInfo": { "message": { "localized": { "en_US": "Hi there, good to see you here!" } }, "callToAction": { "callToActionLabel": "VISIT_COMPANY_WEBSITE", "callToActionTarget": { "landingPageUrl": "https://example.com" } } }, "legalInfo": { "legalInfoId": 2873998916, "privacyPolicyUrl": "https://example.com/privacy", "consents": [ { "id": 1, "label": "I agree to be contacted", "checkRequired": true, "consent": { "localized": { "en_US": "Hi there, good to see you here!" } } } ], "legalDisclaimer": { "localized": { "en_US": "Hi there, good to see you here!" } } } }, "allOf": [ { "type": "object", "properties": { "headline": { "description": "Localised form headline", "example": { "localized": { "en_US": "Hi there, good to see you here!" } }, "allOf": [ { "type": "object", "properties": { "localized": { "type": "object", "description": "Text keyed by locale, e.g. `en_US`. Keys depend on the form locale.", "additionalProperties": { "type": "string" }, "example": { "en_US": "Hi there, good to see you here!" } } }, "required": [ "localized" ], "title": "LinkedInLocalizedTextDTO" } ] }, "description": { "description": "Localised form description", "example": { "localized": { "en_US": "Hi there, good to see you here!" } }, "allOf": [ { "type": "object", "properties": { "localized": { "type": "object", "description": "Text keyed by locale, e.g. `en_US`. Keys depend on the form locale.", "additionalProperties": { "type": "string" }, "example": { "en_US": "Hi there, good to see you here!" } } }, "required": [ "localized" ], "title": "LinkedInLocalizedTextDTO" } ] }, "questions": { "description": "Form questions in display order", "example": [ { "questionId": 20711780444, "question": { "localized": { "en_US": "Hi there, good to see you here!" } }, "name": "lastName", "label": "Last name", "responseRequired": true, "responseEditable": true, "predefinedField": "LAST_NAME", "questionDetails": { "textQuestionDetails": { "maxResponseLength": 300 }, "multipleChoiceQuestionDetails": { "options": [ { "id": 0, "label": "Option 1", "text": { "localized": { "en_US": "Hi there, good to see you here!" } } } ] } } } ], "type": "array", "items": { "type": "object", "properties": { "questionId": { "type": "number", "description": "LinkedIn question id", "example": 20711780444 }, "question": { "description": "Localised question text", "example": { "localized": { "en_US": "Hi there, good to see you here!" } }, "allOf": [ { "type": "object", "properties": { "localized": { "type": "object", "description": "Text keyed by locale, e.g. `en_US`. Keys depend on the form locale.", "additionalProperties": { "type": "string" }, "example": { "en_US": "Hi there, good to see you here!" } } }, "required": [ "localized" ], "title": "LinkedInLocalizedTextDTO" } ] }, "name": { "type": "string", "description": "Machine name for the field", "example": "lastName" }, "label": { "type": "string", "description": "Label shown next to the field", "example": "Last name" }, "responseRequired": { "type": "boolean", "description": "Whether the member must answer", "example": true }, "responseEditable": { "type": "boolean", "description": "Whether the member can edit a prefilled answer", "example": true }, "predefinedField": { "type": "string", "description": "LinkedIn profile field the answer is prefilled from, e.g. `EMAIL`, `JOB_TITLE`. Absent for custom questions.", "example": "LAST_NAME" }, "questionDetails": { "description": "Type-specific configuration", "example": { "textQuestionDetails": { "maxResponseLength": 300 }, "multipleChoiceQuestionDetails": { "options": [ { "id": 0, "label": "Option 1", "text": { "localized": { "en_US": "Hi there, good to see you here!" } } } ] } }, "allOf": [ { "type": "object", "properties": { "textQuestionDetails": { "description": "Present for free-text questions", "example": { "maxResponseLength": 300 }, "allOf": [ { "type": "object", "properties": { "maxResponseLength": { "type": "number", "description": "Maximum characters accepted", "example": 300 } }, "required": [ "maxResponseLength" ], "title": "LinkedInFormTextQuestionDetailsDTO" } ] }, "multipleChoiceQuestionDetails": { "description": "Present for multiple-choice questions", "example": { "options": [ { "id": 0, "label": "Option 1", "text": { "localized": { "en_US": "Hi there, good to see you here!" } } } ] }, "allOf": [ { "type": "object", "properties": { "options": { "description": "Selectable options", "example": [ { "id": 0, "label": "Option 1", "text": { "localized": { "en_US": "Hi there, good to see you here!" } } } ], "type": "array", "items": { "type": "object", "properties": { "id": { "type": "number", "description": "Zero-based option index", "example": 0 }, "label": { "type": "string", "description": "Option label", "example": "Option 1" }, "text": { "description": "Localised option text", "example": { "localized": { "en_US": "Hi there, good to see you here!" } }, "allOf": [ { "type": "object", "properties": { "localized": { "type": "object", "description": "Text keyed by locale, e.g. `en_US`. Keys depend on the form locale.", "additionalProperties": { "type": "string" }, "example": { "en_US": "Hi there, good to see you here!" } } }, "required": [ "localized" ], "title": "LinkedInLocalizedTextDTO" } ] } }, "required": [ "id", "label", "text" ], "title": "LinkedInFormChoiceOptionDTO" } } }, "required": [ "options" ], "title": "LinkedInFormMultipleChoiceDetailsDTO" } ] } }, "title": "LinkedInFormQuestionDetailsDTO" } ] } }, "required": [ "questionId", "question", "name", "label", "responseRequired", "responseEditable", "questionDetails" ], "title": "LinkedInFormQuestionDTO" } }, "postSubmissionInfo": { "description": "What happens after submission", "example": { "message": { "localized": { "en_US": "Hi there, good to see you here!" } }, "callToAction": { "callToActionLabel": "VISIT_COMPANY_WEBSITE", "callToActionTarget": { "landingPageUrl": "https://example.com" } } }, "allOf": [ { "type": "object", "properties": { "message": { "description": "Localised thank-you message", "example": { "localized": { "en_US": "Hi there, good to see you here!" } }, "allOf": [ { "type": "object", "properties": { "localized": { "type": "object", "description": "Text keyed by locale, e.g. `en_US`. Keys depend on the form locale.", "additionalProperties": { "type": "string" }, "example": { "en_US": "Hi there, good to see you here!" } } }, "required": [ "localized" ], "title": "LinkedInLocalizedTextDTO" } ] }, "callToAction": { "description": "Follow-up action offered after submission", "example": { "callToActionLabel": "VISIT_COMPANY_WEBSITE", "callToActionTarget": { "landingPageUrl": "https://example.com" } }, "allOf": [ { "type": "object", "properties": { "callToActionLabel": { "type": "string", "description": "Button label", "example": "VISIT_COMPANY_WEBSITE" }, "callToActionTarget": { "description": "Button destination", "example": { "landingPageUrl": "https://example.com" }, "allOf": [ { "type": "object", "properties": { "landingPageUrl": { "type": "string", "description": "Where the member is sent after submitting", "example": "https://example.com" } }, "required": [ "landingPageUrl" ], "title": "LinkedInFormCallToActionTargetDTO" } ] } }, "required": [ "callToActionLabel", "callToActionTarget" ], "title": "LinkedInFormCallToActionDTO" } ] } }, "required": [ "message", "callToAction" ], "title": "LinkedInFormPostSubmissionInfoDTO" } ] }, "legalInfo": { "description": "Privacy policy and consent configuration", "example": { "legalInfoId": 2873998916, "privacyPolicyUrl": "https://example.com/privacy", "consents": [ { "id": 1, "label": "I agree to be contacted", "checkRequired": true, "consent": { "localized": { "en_US": "Hi there, good to see you here!" } } } ], "legalDisclaimer": { "localized": { "en_US": "Hi there, good to see you here!" } } }, "allOf": [ { "type": "object", "properties": { "legalInfoId": { "type": "number", "description": "LinkedIn legal info id", "example": 2873998916 }, "privacyPolicyUrl": { "type": "string", "description": "Privacy policy URL shown on the form", "example": "https://example.com/privacy" }, "consents": { "description": "Custom consent checkboxes. Empty array when none.", "example": [ { "id": 1, "label": "I agree to be contacted", "checkRequired": true, "consent": { "localized": { "en_US": "Hi there, good to see you here!" } } } ], "type": "array", "items": { "type": "object", "properties": { "id": { "type": "number", "description": "Consent id within the form", "example": 1 }, "label": { "type": "string", "description": "Consent label", "example": "I agree to be contacted" }, "checkRequired": { "type": "boolean", "description": "Whether the member must tick the box to submit", "example": true }, "consent": { "description": "Localised consent text", "example": { "localized": { "en_US": "Hi there, good to see you here!" } }, "allOf": [ { "type": "object", "properties": { "localized": { "type": "object", "description": "Text keyed by locale, e.g. `en_US`. Keys depend on the form locale.", "additionalProperties": { "type": "string" }, "example": { "en_US": "Hi there, good to see you here!" } } }, "required": [ "localized" ], "title": "LinkedInLocalizedTextDTO" } ] } }, "required": [ "id", "label", "checkRequired", "consent" ], "title": "LinkedInFormConsentDTO" } }, "legalDisclaimer": { "description": "Optional legal disclaimer text", "example": { "localized": { "en_US": "Hi there, good to see you here!" } }, "allOf": [ { "type": "object", "properties": { "localized": { "type": "object", "description": "Text keyed by locale, e.g. `en_US`. Keys depend on the form locale.", "additionalProperties": { "type": "string" }, "example": { "en_US": "Hi there, good to see you here!" } } }, "required": [ "localized" ], "title": "LinkedInLocalizedTextDTO" } ] } }, "required": [ "legalInfoId", "privacyPolicyUrl", "consents" ], "title": "LinkedInFormLegalInfoDTO" } ] } }, "required": [ "headline", "questions", "postSubmissionInfo", "legalInfo" ], "title": "LinkedInFormContentDTO" } ] } }, "title": "LinkedInLeadFormDTO" } }, { "type": "object", "properties": { "leadForms": { "description": "Page of LinkedIn lead gen forms", "example": [ { "id": 1025914010, "name": "Q3 demand generation form", "state": "PUBLISHED", "versionId": 1, "created": 1787056838757, "lastModified": 1787057842322, "creationLocale": { "country": "US", "language": "en" }, "owner": { "sponsoredAccount": "urn:li:sponsoredAccount:556129919" }, "reviewInfo": { "reviewStatus": "REJECTED", "rejectionReasons": [ "MISSING_PRIVACY_POLICY", "NONFUNCTIONAL_SITE" ], "lastUpdated": 1787057842315 }, "hiddenFields": [ { "name": "utm_source", "value": "linkedin" } ], "content": { "headline": { "localized": { "en_US": "Hi there, good to see you here!" } }, "description": { "localized": { "en_US": "Hi there, good to see you here!" } }, "questions": [ { "questionId": 20711780444, "question": { "localized": { "en_US": "Hi there, good to see you here!" } }, "name": "lastName", "label": "Last name", "responseRequired": true, "responseEditable": true, "predefinedField": "LAST_NAME", "questionDetails": { "textQuestionDetails": { "maxResponseLength": 300 }, "multipleChoiceQuestionDetails": { "options": [ { "id": 0, "label": "Option 1", "text": { "localized": { "en_US": "Hi there, good to see you here!" } } } ] } } } ], "postSubmissionInfo": { "message": { "localized": { "en_US": "Hi there, good to see you here!" } }, "callToAction": { "callToActionLabel": "VISIT_COMPANY_WEBSITE", "callToActionTarget": { "landingPageUrl": "https://example.com" } } }, "legalInfo": { "legalInfoId": 2873998916, "privacyPolicyUrl": "https://example.com/privacy", "consents": [ { "id": 1, "label": "I agree to be contacted", "checkRequired": true, "consent": { "localized": { "en_US": "Hi there, good to see you here!" } } } ], "legalDisclaimer": { "localized": { "en_US": "Hi there, good to see you here!" } } } } } ], "type": "array", "items": { "type": "object", "properties": { "id": { "type": "number", "description": "Form id. Returned as a number.", "example": 1025914010 }, "name": { "type": "string", "description": "Form name", "example": "Q3 demand generation form" }, "state": { "type": "string", "description": "Form lifecycle state", "example": "PUBLISHED" }, "versionId": { "type": "number", "description": "Version of the form definition", "example": 1 }, "created": { "type": "number", "description": "When the form was created, epoch milliseconds", "example": 1787056838757 }, "lastModified": { "type": "number", "description": "When the form was last modified, epoch milliseconds", "example": 1787057842322 }, "creationLocale": { "description": "Locale the form was authored in", "example": { "country": "US", "language": "en" }, "allOf": [ { "type": "object", "properties": { "country": { "type": "string", "description": "Two-letter country code", "example": "US" }, "language": { "type": "string", "description": "Two-letter language code", "example": "en" } }, "required": [ "country", "language" ], "title": "LinkedInLocaleDTO" } ] }, "owner": { "description": "Account that owns the form", "example": { "sponsoredAccount": "urn:li:sponsoredAccount:556129919" }, "allOf": [ { "type": "object", "properties": { "sponsoredAccount": { "type": "string", "description": "Sponsored account URN that owns the form", "example": "urn:li:sponsoredAccount:556129919" } }, "required": [ "sponsoredAccount" ], "title": "LinkedInFormOwnerDTO" } ] }, "reviewInfo": { "description": "LinkedIn review outcome. Absent on a form that has just been created and not yet reviewed; present on reads.", "example": { "reviewStatus": "REJECTED", "rejectionReasons": [ "MISSING_PRIVACY_POLICY", "NONFUNCTIONAL_SITE" ], "lastUpdated": 1787057842315 }, "allOf": [ { "type": "object", "properties": { "reviewStatus": { "type": "string", "description": "Review outcome", "enum": [ "AUTO_APPROVED", "NEEDS_REVIEW", "REJECTED", "APPROVED" ], "example": "REJECTED" }, "rejectionReasons": { "description": "Why the form was rejected. Empty array when it was not.", "example": [ "MISSING_PRIVACY_POLICY", "NONFUNCTIONAL_SITE" ], "type": "array", "items": { "type": "string" } }, "lastUpdated": { "type": "number", "description": "When the review last changed, epoch milliseconds", "example": 1787057842315 } }, "required": [ "reviewStatus", "rejectionReasons", "lastUpdated" ], "title": "LinkedInFormReviewInfoDTO" } ] }, "hiddenFields": { "description": "Hidden fields submitted alongside the lead. Empty array when none.", "example": [ { "name": "utm_source", "value": "linkedin" } ], "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "description": "Field name", "example": "utm_source" }, "value": { "type": "string", "description": "Field value submitted with the lead", "example": "linkedin" } }, "required": [ "name", "value" ], "title": "LinkedInFormHiddenFieldDTO" } }, "content": { "description": "Form definition", "example": { "headline": { "localized": { "en_US": "Hi there, good to see you here!" } }, "description": { "localized": { "en_US": "Hi there, good to see you here!" } }, "questions": [ { "questionId": 20711780444, "question": { "localized": { "en_US": "Hi there, good to see you here!" } }, "name": "lastName", "label": "Last name", "responseRequired": true, "responseEditable": true, "predefinedField": "LAST_NAME", "questionDetails": { "textQuestionDetails": { "maxResponseLength": 300 }, "multipleChoiceQuestionDetails": { "options": [ { "id": 0, "label": "Option 1", "text": { "localized": { "en_US": "Hi there, good to see you here!" } } } ] } } } ], "postSubmissionInfo": { "message": { "localized": { "en_US": "Hi there, good to see you here!" } }, "callToAction": { "callToActionLabel": "VISIT_COMPANY_WEBSITE", "callToActionTarget": { "landingPageUrl": "https://example.com" } } }, "legalInfo": { "legalInfoId": 2873998916, "privacyPolicyUrl": "https://example.com/privacy", "consents": [ { "id": 1, "label": "I agree to be contacted", "checkRequired": true, "consent": { "localized": { "en_US": "Hi there, good to see you here!" } } } ], "legalDisclaimer": { "localized": { "en_US": "Hi there, good to see you here!" } } } }, "allOf": [ { "type": "object", "properties": { "headline": { "description": "Localised form headline", "example": { "localized": { "en_US": "Hi there, good to see you here!" } }, "allOf": [ { "type": "object", "properties": { "localized": { "type": "object", "description": "Text keyed by locale, e.g. `en_US`. Keys depend on the form locale.", "additionalProperties": { "type": "string" }, "example": { "en_US": "Hi there, good to see you here!" } } }, "required": [ "localized" ], "title": "LinkedInLocalizedTextDTO" } ] }, "description": { "description": "Localised form description", "example": { "localized": { "en_US": "Hi there, good to see you here!" } }, "allOf": [ { "type": "object", "properties": { "localized": { "type": "object", "description": "Text keyed by locale, e.g. `en_US`. Keys depend on the form locale.", "additionalProperties": { "type": "string" }, "example": { "en_US": "Hi there, good to see you here!" } } }, "required": [ "localized" ], "title": "LinkedInLocalizedTextDTO" } ] }, "questions": { "description": "Form questions in display order", "example": [ { "questionId": 20711780444, "question": { "localized": { "en_US": "Hi there, good to see you here!" } }, "name": "lastName", "label": "Last name", "responseRequired": true, "responseEditable": true, "predefinedField": "LAST_NAME", "questionDetails": { "textQuestionDetails": { "maxResponseLength": 300 }, "multipleChoiceQuestionDetails": { "options": [ { "id": 0, "label": "Option 1", "text": { "localized": { "en_US": "Hi there, good to see you here!" } } } ] } } } ], "type": "array", "items": { "type": "object", "properties": { "questionId": { "type": "number", "description": "LinkedIn question id", "example": 20711780444 }, "question": { "description": "Localised question text", "example": { "localized": { "en_US": "Hi there, good to see you here!" } }, "allOf": [ { "type": "object", "properties": { "localized": { "type": "object", "description": "Text keyed by locale, e.g. `en_US`. Keys depend on the form locale.", "additionalProperties": { "type": "string" }, "example": { "en_US": "Hi there, good to see you here!" } } }, "required": [ "localized" ], "title": "LinkedInLocalizedTextDTO" } ] }, "name": { "type": "string", "description": "Machine name for the field", "example": "lastName" }, "label": { "type": "string", "description": "Label shown next to the field", "example": "Last name" }, "responseRequired": { "type": "boolean", "description": "Whether the member must answer", "example": true }, "responseEditable": { "type": "boolean", "description": "Whether the member can edit a prefilled answer", "example": true }, "predefinedField": { "type": "string", "description": "LinkedIn profile field the answer is prefilled from, e.g. `EMAIL`, `JOB_TITLE`. Absent for custom questions.", "example": "LAST_NAME" }, "questionDetails": { "description": "Type-specific configuration", "example": { "textQuestionDetails": { "maxResponseLength": 300 }, "multipleChoiceQuestionDetails": { "options": [ { "id": 0, "label": "Option 1", "text": { "localized": { "en_US": "Hi there, good to see you here!" } } } ] } }, "allOf": [ { "type": "object", "properties": { "textQuestionDetails": { "description": "Present for free-text questions", "example": { "maxResponseLength": 300 }, "allOf": [ { "type": "object", "properties": { "maxResponseLength": { "type": "number", "description": "Maximum characters accepted", "example": 300 } }, "required": [ "maxResponseLength" ], "title": "LinkedInFormTextQuestionDetailsDTO" } ] }, "multipleChoiceQuestionDetails": { "description": "Present for multiple-choice questions", "example": { "options": [ { "id": 0, "label": "Option 1", "text": { "localized": { "en_US": "Hi there, good to see you here!" } } } ] }, "allOf": [ { "type": "object", "properties": { "options": { "description": "Selectable options", "example": [ { "id": 0, "label": "Option 1", "text": { "localized": { "en_US": "Hi there, good to see you here!" } } } ], "type": "array", "items": { "type": "object", "properties": { "id": { "type": "number", "description": "Zero-based option index", "example": 0 }, "label": { "type": "string", "description": "Option label", "example": "Option 1" }, "text": { "description": "Localised option text", "example": { "localized": { "en_US": "Hi there, good to see you here!" } }, "allOf": [ { "type": "object", "properties": { "localized": { "type": "object", "description": "Text keyed by locale, e.g. `en_US`. Keys depend on the form locale.", "additionalProperties": { "type": "string" }, "example": { "en_US": "Hi there, good to see you here!" } } }, "required": [ "localized" ], "title": "LinkedInLocalizedTextDTO" } ] } }, "required": [ "id", "label", "text" ], "title": "LinkedInFormChoiceOptionDTO" } } }, "required": [ "options" ], "title": "LinkedInFormMultipleChoiceDetailsDTO" } ] } }, "title": "LinkedInFormQuestionDetailsDTO" } ] } }, "required": [ "questionId", "question", "name", "label", "responseRequired", "responseEditable", "questionDetails" ], "title": "LinkedInFormQuestionDTO" } }, "postSubmissionInfo": { "description": "What happens after submission", "example": { "message": { "localized": { "en_US": "Hi there, good to see you here!" } }, "callToAction": { "callToActionLabel": "VISIT_COMPANY_WEBSITE", "callToActionTarget": { "landingPageUrl": "https://example.com" } } }, "allOf": [ { "type": "object", "properties": { "message": { "description": "Localised thank-you message", "example": { "localized": { "en_US": "Hi there, good to see you here!" } }, "allOf": [ { "type": "object", "properties": { "localized": { "type": "object", "description": "Text keyed by locale, e.g. `en_US`. Keys depend on the form locale.", "additionalProperties": { "type": "string" }, "example": { "en_US": "Hi there, good to see you here!" } } }, "required": [ "localized" ], "title": "LinkedInLocalizedTextDTO" } ] }, "callToAction": { "description": "Follow-up action offered after submission", "example": { "callToActionLabel": "VISIT_COMPANY_WEBSITE", "callToActionTarget": { "landingPageUrl": "https://example.com" } }, "allOf": [ { "type": "object", "properties": { "callToActionLabel": { "type": "string", "description": "Button label", "example": "VISIT_COMPANY_WEBSITE" }, "callToActionTarget": { "description": "Button destination", "example": { "landingPageUrl": "https://example.com" }, "allOf": [ { "type": "object", "properties": { "landingPageUrl": { "type": "string", "description": "Where the member is sent after submitting", "example": "https://example.com" } }, "required": [ "landingPageUrl" ], "title": "LinkedInFormCallToActionTargetDTO" } ] } }, "required": [ "callToActionLabel", "callToActionTarget" ], "title": "LinkedInFormCallToActionDTO" } ] } }, "required": [ "message", "callToAction" ], "title": "LinkedInFormPostSubmissionInfoDTO" } ] }, "legalInfo": { "description": "Privacy policy and consent configuration", "example": { "legalInfoId": 2873998916, "privacyPolicyUrl": "https://example.com/privacy", "consents": [ { "id": 1, "label": "I agree to be contacted", "checkRequired": true, "consent": { "localized": { "en_US": "Hi there, good to see you here!" } } } ], "legalDisclaimer": { "localized": { "en_US": "Hi there, good to see you here!" } } }, "allOf": [ { "type": "object", "properties": { "legalInfoId": { "type": "number", "description": "LinkedIn legal info id", "example": 2873998916 }, "privacyPolicyUrl": { "type": "string", "description": "Privacy policy URL shown on the form", "example": "https://example.com/privacy" }, "consents": { "description": "Custom consent checkboxes. Empty array when none.", "example": [ { "id": 1, "label": "I agree to be contacted", "checkRequired": true, "consent": { "localized": { "en_US": "Hi there, good to see you here!" } } } ], "type": "array", "items": { "type": "object", "properties": { "id": { "type": "number", "description": "Consent id within the form", "example": 1 }, "label": { "type": "string", "description": "Consent label", "example": "I agree to be contacted" }, "checkRequired": { "type": "boolean", "description": "Whether the member must tick the box to submit", "example": true }, "consent": { "description": "Localised consent text", "example": { "localized": { "en_US": "Hi there, good to see you here!" } }, "allOf": [ { "type": "object", "properties": { "localized": { "type": "object", "description": "Text keyed by locale, e.g. `en_US`. Keys depend on the form locale.", "additionalProperties": { "type": "string" }, "example": { "en_US": "Hi there, good to see you here!" } } }, "required": [ "localized" ], "title": "LinkedInLocalizedTextDTO" } ] } }, "required": [ "id", "label", "checkRequired", "consent" ], "title": "LinkedInFormConsentDTO" } }, "legalDisclaimer": { "description": "Optional legal disclaimer text", "example": { "localized": { "en_US": "Hi there, good to see you here!" } }, "allOf": [ { "type": "object", "properties": { "localized": { "type": "object", "description": "Text keyed by locale, e.g. `en_US`. Keys depend on the form locale.", "additionalProperties": { "type": "string" }, "example": { "en_US": "Hi there, good to see you here!" } } }, "required": [ "localized" ], "title": "LinkedInLocalizedTextDTO" } ] } }, "required": [ "legalInfoId", "privacyPolicyUrl", "consents" ], "title": "LinkedInFormLegalInfoDTO" } ] } }, "required": [ "headline", "questions", "postSubmissionInfo", "legalInfo" ], "title": "LinkedInFormContentDTO" } ] } }, "title": "LinkedInLeadFormDTO" } }, "paging": { "description": "Pagination cursor", "example": { "next": "100" }, "allOf": [ { "type": "object", "properties": { "next": { "type": "string", "description": "Cursor for the next page of results, or null when there are no more pages", "example": "100", "nullable": true } }, "required": [ "next" ], "title": "LinkedInLeadFormsPagingDTO" } ] } }, "required": [ "leadForms", "paging" ], "title": "PaginatedLinkedInLeadFormsDTO" } ] }, "BadRequestDTO": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 400 }, "message": { "type": "string", "example": "Bad Request" } }, "title": "BadRequestDTO" }, "UnauthorizedDTO": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 401 }, "message": { "type": "string", "example": "Invalid token: access token is invalid" }, "error": { "type": "string", "example": "Unauthorized" } }, "title": "UnauthorizedDTO" }, "UnprocessableDTO": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 422 }, "message": { "example": [ "Unprocessable Entity" ], "type": "array", "items": { "type": "string" } }, "error": { "type": "string", "example": "Unprocessable Entity" } }, "title": "UnprocessableDTO" }, "InternalServerErrorDTO": { "type": "object", "properties": { "statusCode": { "type": "number", "description": "HTTP status code for an unexpected server error", "example": 500 }, "message": { "type": "string", "description": "Error message describing the server failure", "example": "Internal Server Error" } }, "title": "InternalServerErrorDTO" } } } } ``` ## Code Examples **cURL** ```bash curl -L -X GET 'https://services.leadconnectorhq.com/ad-publishing/linkedin//forms?locationId=' \ -H 'Authorization: Bearer ' \ -H 'Version: 2021-04-15' ``` **Node.js** ```javascript const options = { method: 'GET', headers: { Authorization: 'Bearer ', Version: '2021-04-15' } }; try { const response = await fetch('https://services.leadconnectorhq.com/ad-publishing/linkedin//forms?locationId=', options); const data = await response.json(); console.log(data); } catch (error) { console.error(error); } ``` **Python** ```python import requests url = "https://services.leadconnectorhq.com/ad-publishing/linkedin/{accountId}/forms" headers = { "Authorization": "Bearer ", "Version": "2021-04-15" } params = { "locationId": "" } response = requests.get(url, params=params, headers=headers) print(response.json()) ``` **PHP** ```php 'https://services.leadconnectorhq.com/ad-publishing/linkedin//forms?locationId=', CURLOPT_RETURNTRANSFER => true, CURLOPT_CUSTOMREQUEST => 'GET', CURLOPT_HTTPHEADER => [ 'Authorization: Bearer ', 'Version: 2021-04-15', ], ]); $response = curl_exec($curl); curl_close($curl); echo $response; ``` **Java** ```java HttpResponse response = Unirest .get("https://services.leadconnectorhq.com/ad-publishing/linkedin//forms?locationId=") .header("Authorization", "Bearer ") .header("Version", "2021-04-15") .asString(); ``` **Go** ```go package main import ( "fmt" "net/http" "io" ) func main() { url := "https://services.leadconnectorhq.com/ad-publishing/linkedin//forms?locationId=" req, _ := http.NewRequest("GET", url, nil) req.Header.Add("Authorization", "Bearer ") req.Header.Add("Version", "2021-04-15") res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := io.ReadAll(res.Body) fmt.Println(string(body)) } ``` **Ruby** ```ruby require 'uri' require 'net/http' url = URI("https://services.leadconnectorhq.com/ad-publishing/linkedin//forms?locationId=") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true request = Net::HTTP::Get.new(url) request["Authorization"] = "Bearer " request["Version"] = "2021-04-15" response = http.request(request) puts response.read_body ``` **PowerShell** ```powershell $headers = @{ "Authorization" = "Bearer " "Version" = "2021-04-15" } $response = Invoke-RestMethod -Uri 'https://services.leadconnectorhq.com/ad-publishing/linkedin//forms?locationId=' -Method 'GET' -Headers $headers $response | ConvertTo-Json ```