PIpinterest
customer_lists

Get customer lists

Changed on

Get a set of customer lists including id and name based on the filters provided.

(Customer lists are a type of audience.) For more information, see Audience targeting or the Audiences section of the ads management guide.

get/ad_accounts/{ad_account_id}/customer_lists

Request

Path parameters

ad_account_idstring required

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.

exclude_ncaboolean

When true, excludes customer lists uploaded for new customer acquisition (expanded matching) from the result. Defaults to false (include all).

Response

The request has succeeded.

bookmarkstring nullable

Example response

{
  "items": [
    {
      "ad_account_id": "549756359984",
      "created_time": 1452208622,
      "id": "643",
      "name": "The Glengarry Glen Ross leads",
      "num_batches": 2,
      "num_uploaded_user_records": 11,
      "status": "PROCESSING",
      "type": "customerlist",
      "updated_time": 1461269616
    }
  ]
}

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

      added the new optional query request parameter exclude_nca

    • 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 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

  • v5f9321315766fRevision changes
    • breaking

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