Get lead forms
GET {{baseUrl}}/ad_accounts/:ad_account_id/lead_forms?page_size=25&order=ASCENDING&bookmark=<string>
Gets all Lead Forms associated with an ad account ID. Retrieving an advertiser's list of lead forms will only contain results if you're a part of the Lead ads beta. If you're interested in joining the beta, please reach out to your Pinterest account manager.
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
page_size | number | Maximum number of items to include in a single page of the response. See documentation on <a href='/docs/getting-started/pagination/'>Pagination</a> for more information. | |
order | string | 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. | |||
bookmark | string | Cursor used to fetch the next page of items |
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
Accept | string |
RESPONSES
status: OK
{"items":[{"name":"\u003cstring\u003e","privacy_policy_link":"\u003cstring\u003e","has_accepted_terms":"\u003cboolean\u003e","completion_message":"\u003cstring\u003e","status":"DRAFT","disclosure_language":"\u003cstring\u003e","questions":[{"question_type":"PREFERRED_CONTACT_METHOD","custom_question_field_type":null,"custom_question_label":"\u003cstring\u003e","custom_question_options":["\u003cstring\u003e","\u003cstring\u003e","\u003cstring\u003e","\u003cstring\u003e","\u003cstring\u003e"]},{"question_type":"LAST_NAME","custom_question_field_type":"DROPDOWN","custom_question_label":"\u003cstring\u003e","custom_question_options":["\u003cstring\u003e","\u003cstring\u003e","\u003cstring\u003e","\u003cstring\u003e","\u003cstring\u003e"]},{"question_type":"FULL_NAME","custom_question_field_type":"TEXT_FIELD","custom_question_label":"\u003cstring\u003e","custom_question_options":["\u003cstring\u003e","\u003cstring\u003e","\u003cstring\u003e","\u003cstring\u003e","\u003cstring\u003e"]},{"question_type":"LAST_NAME","custom_question_field_type":"CHECKBOX","custom_question_label":"\u003cstring\u003e","custom_question_options":["\u003cstring\u003e","\u003cstring\u003e","\u003cstring\u003e","\u003cstring\u003e","\u003cstring\u003e"]},{"question_type":"FULL_NAME","custom_question_field_type":"TEXT_AREA","custom_question_label":"\u003cstring\u003e","custom_question_options":["\u003cstring\u003e","\u003cstring\u003e","\u003cstring\u003e","\u003cstring\u003e","\u003cstring\u003e"]},{"question_type":"PHONE_NUMBER","custom_question_field_type":"DROPDOWN","custom_question_label":"\u003cstring\u003e","custom_question_options":["\u003cstring\u003e","\u003cstring\u003e","\u003cstring\u003e","\u003cstring\u003e","\u003cstring\u003e"]},{"question_type":"STATE_PROVINCE","custom_question_field_type":"DROPDOWN","custom_question_label":"\u003cstring\u003e","custom_question_options":["\u003cstring\u003e","\u003cstring\u003e","\u003cstring\u003e","\u003cstring\u003e","\u003cstring\u003e"]},{"question_type":"GENDER","custom_question_field_type":"TEXT_FIELD","custom_question_label":"\u003cstring\u003e","custom_question_options":["\u003cstring\u003e","\u003cstring\u003e","\u003cstring\u003e","\u003cstring\u003e","\u003cstring\u003e"]},{"question_type":"ZIP_CODE","custom_question_field_type":null,"custom_question_label":"\u003cstring\u003e","custom_question_options":["\u003cstring\u003e","\u003cstring\u003e","\u003cstring\u003e","\u003cstring\u003e","\u003cstring\u003e"]},{"question_type":"COUNTRY","custom_question_field_type":"TEXT_FIELD","custom_question_label":"\u003cstring\u003e","custom_question_options":["\u003cstring\u003e","\u003cstring\u003e","\u003cstring\u003e","\u003cstring\u003e","\u003cstring\u003e"]}],"id":"955887","ad_account_id":"960","created_time":"\u003cinteger\u003e","updated_time":"\u003cinteger\u003e"},{"name":"\u003cstring\u003e","privacy_policy_link":"\u003cstring\u003e","has_accepted_terms":"\u003cboolean\u003e","completion_message":"\u003cstring\u003e","status":"ACTIVE","disclosure_language":"\u003cstring\u003e","questions":[{"question_type":"CITY","custom_question_field_type":"TEXT_AREA","custom_question_label":"\u003cstring\u003e","custom_question_options":["\u003cstring\u003e","\u003cstring\u003e","\u003cstring\u003e","\u003cstring\u003e","\u003cstring\u003e"]},{"question_type":"STATE_PROVINCE","custom_question_field_type":"CHECKBOX","custom_question_label":"\u003cstring\u003e","custom_question_options":["\u003cstring\u003e","\u003cstring\u003e","\u003cstring\u003e","\u003cstring\u003e","\u003cstring\u003e"]},{"question_type":"FULL_NAME","custom_question_field_type":null,"custom_question_label":"\u003cstring\u003e","custom_question_options":["\u003cstring\u003e","\u003cstring\u003e","\u003cstring\u003e","\u003cstring\u003e","\u003cstring\u003e"]},{"question_type":"FULL_NAME","custom_question_field_type":"TEXT_AREA","custom_question_label":"\u003cstring\u003e","custom_question_options":["\u003cstring\u003e","\u003cstring\u003e","\u003cstring\u003e","\u003cstring\u003e","\u003cstring\u003e"]},{"question_type":"FIRST_NAME","custom_question_field_type":"RADIO_LIST","custom_question_label":"\u003cstring\u003e","custom_question_options":["\u003cstring\u003e","\u003cstring\u003e","\u003cstring\u003e","\u003cstring\u003e","\u003cstring\u003e"]},{"question_type":"FULL_NAME","custom_question_field_type":null,"custom_question_label":"\u003cstring\u003e","custom_question_options":["\u003cstring\u003e","\u003cstring\u003e","\u003cstring\u003e","\u003cstring\u003e","\u003cstring\u003e"]},{"question_type":"CUSTOM","custom_question_field_type":"TEXT_FIELD","custom_question_label":"\u003cstring\u003e","custom_question_options":["\u003cstring\u003e","\u003cstring\u003e","\u003cstring\u003e","\u003cstring\u003e","\u003cstring\u003e"]},{"question_type":"FIRST_NAME","custom_question_field_type":"DROPDOWN","custom_question_label":"\u003cstring\u003e","custom_question_options":["\u003cstring\u003e","\u003cstring\u003e","\u003cstring\u003e","\u003cstring\u003e","\u003cstring\u003e"]},{"question_type":"CITY","custom_question_field_type":"DROPDOWN","custom_question_label":"\u003cstring\u003e","custom_question_options":["\u003cstring\u003e","\u003cstring\u003e","\u003cstring\u003e","\u003cstring\u003e","\u003cstring\u003e"]},{"question_type":"COUNTRY","custom_question_field_type":"DROPDOWN","custom_question_label":"\u003cstring\u003e","custom_question_options":["\u003cstring\u003e","\u003cstring\u003e","\u003cstring\u003e","\u003cstring\u003e","\u003cstring\u003e"]}],"id":"2977755888","ad_account_id":"14867293219","created_time":"\u003cinteger\u003e","updated_time":"\u003cinteger\u003e"}],"bookmark":"\u003cstring\u003e"}