Skip to main content
LinkedIn AdsVersion: v3New

Get lead forms

GET/ad-publishing/linkedin/{accountId}/forms
deprecated

This endpoint has been deprecated and may be replaced or removed in future versions of the API.

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.

Authorizations

Authorizationstringheaderrequired

Bearer authentication header of the form Bearer <token>, where <token> is your access token.

Scope:adPublishing.readonly
Auth methods:OAuthPrivate Integration
Token type:Sub-Account Token

Request​

Headers

Versionstringrequired

API Version

Available optionsv3
Example:v3

Path Parameters

accountIdstringrequired

Account identifier

Example:12345678

Query Parameters

locationIdstringrequired

Location identifier

Example:loc_abc123
projectionstring[]

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.

Available optionsidnamestatecreatedlastModifiedversionIdcreationLocaleownerreviewInforeviewInfo.reviewStatusreviewInfo.rejectionReasonscontent
Example:["id","name","state","created","reviewInfo.reviewStatus"]
limitstring

Page size for a paginated fetch (max 100). When set, the response is a { leadForms, paging } envelope instead of a plain array.

Example:100
pageTokenstring

Opaque cursor for the next batch, taken from the previous response paging.next

Example:100

Response

application/json

A plain array of lead forms (default), or a { leadForms, paging } envelope when limit is provided

oneOf
  • Array items
    • idnumber

    Form id. Returned as a number.

    Example:1025914010
    namestring

    Form name

    Example:Q3 demand generation form
    statestring

    Form lifecycle state

    Example:PUBLISHED
    versionIdnumber

    Version of the form definition

    Example:1
    creatednumber

    When the form was created, epoch milliseconds

    Example:1787056838757
    lastModifiednumber

    When the form was last modified, epoch milliseconds

    Example:1787057842322
    creationLocaleobject

    Locale the form was authored in

    ownerobject

    Account that owns the form

    reviewInfoobject

    LinkedIn review outcome. Absent on a form that has just been created and not yet reviewed; present on reads.

    hiddenFieldsobject[]

    Hidden fields submitted alongside the lead. Empty array when none.

    contentobject

    Form definition