PHphilterd
Custom Lists

List custom lists.

Changed on

Lists the caller's custom lists, all of them, each with its name, description, and number of items. Admins may list another user's lists with owner, or every user's with all_users=true, which is paged with offset and limit, adds each list's owner, and requires ADMIN_CROSS_USER_ACCESS_ENABLED. Requires the lists:read scope.

get/api/lists

Request

  • Base URL
    / (relative, and the document was published on a file host, not at the API’s origin)
  • URL
    /api/lists
  • Auth
    HTTP bearer

Query parameters

ownerstring
all_usersboolean
qstring
sortstring
orderstring
offsetinteger
limitinteger

Headers

Authorizationstring required

Response

A page of lists, each with its name, description, and size (with all_users, its owner too), and the total.

totalinteger

How many lists the listing has across every page.

Changes

  • c4f85daa9208Revision changes
    • breaking

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

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

  • 1e983a7188bfRevision changes
    • breaking

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

    • info

      added the new optional query request parameter order

    • info

      added the new optional query request parameter q

    • info

      added the new optional query request parameter sort

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status