Sign in
lead_forms

List lead forms

This feature is currently in beta and not available to all apps, if you're interested in joining the beta, please reach out to your Pinterest account manager.

List lead forms associated with an ad account ID.

For more, see Lead ads.

get/ad_accounts/{ad_account_id}/lead_forms

Path parameters

ad_account_idstring required

Unique identifier of an ad account.

Query parameters

bookmarkstring

Cursor used to fetch the next page of items

page_sizeinteger

Maximum number of items to include in a single page. See documentation on Pagination for more information.

order'ASCENDING' | 'DESCENDING'

The order in which to sort the items returned: "ASCENDING" or "DESCENDING" by ID. Note that higher-value IDs are associated with more-recently added items.

Response

The request has succeeded.

bookmarkstring nullable

Example response

{
  "items": [
    {
      "completion_message": "Thank you for submitting. We will contact you soon.",
      "disclosure_language": "By entering your personal information, you agree that your data will be collected and used.",
      "name": "Lead Form 3/14/2023",
      "policy_links": [
        {
          "label": "Copyright",
          "link": "https://policy.pinterest.com/en/copyright"
        }
      ],
      "privacy_policy_link": "https://www.advertisername.com/privacy-policy",
      "questions": [
        {
          "question_type": "CUSTOM",
          "custom_question_field_type": "CHECKBOX",
          "custom_question_label": "What is your favorite animal?",
          "custom_question_options": [
            "Dog",
            "Cat",
            "Bird",
            "Turtle"
          ]
        }
      ],
      "status": "DRAFT"
    }
  ]
}

Changes

Changed in 5 of the 29 revisions of this API.3211

  • v5b698c180678a27See the full diff
    • ▲

      for the query request parameter order, default value ASCENDING was added

      request-parameter-default-value-added

    • ▲

      the response's body type changed from no type to object for status

      response-body-type-changed

    • ○

      removed subschema #2 from the response body allOf list for the response status

      response-body-all-of-removed

    • ○

      added the non-success response with the status

      response-non-success-status-added

    • ○

      added the non-success response with the status

      response-non-success-status-added

    • ○

      added the non-success response with the status

      response-non-success-status-added

    • ○

      added the non-success response with the status

      response-non-success-status-added

    • ○

      added the optional property to the response with the status

      response-optional-property-added

    • ○

      added the required property to the response with the status

      response-required-property-added

    This revision also has 182 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • v589c27ed39cfd2See the full diff
    • ○

      added the optional property /////// to the response with the status

      response-optional-property-added

    • ○

      removed the PREFERRED_CONTACT_METHOD enum value from the ///////// response property for the response status

      response-property-enum-value-removed

    This revision also has 4 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • v5f9321315766f1See the full diff
    • ▲

      the response's property type changed from no type to object for status

      response-property-type-changed

    This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • v57529b464d5cb21See the full diff
    • ●

      added the new ADDRESS enum value to the ///////// response property for the response status

      response-property-enum-value-added

    • ●

      added the new DATE_OF_BIRTH enum value to the ///////// response property for the response status

      response-property-enum-value-added

    • ○

      removed the DROPDOWN enum value from the ///////// response property for the response status

      response-property-enum-value-removed

    This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • v5689b4b2676391See the full diff
    • ○

      endpoint added

      endpoint-added

    This revision also has 2 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog