PIpinterest
lead_forms

List lead forms

Changed on

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

Request

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

  • v5b698c180678aRevision changes
    • breaking

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

    • breaking

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

    • info

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

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the optional property to the response with the status

    • info

      added the required property to the response with the status

  • v589c27ed39cfdRevision changes
    • info

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

    • info

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