Add "includeDetails" parameter to "Retrieve lists" API Endpoint

NikolayStarostin

Currently "Retrieve lists" Endpoint returns only an array of lists which contain only "id" and "name" information.

[
  {
    "id": "101000000000",
    "name": "Organization"
  },
  {
    "id": "101000000001",
    "name": "opportunities"
  },
]

For my use case, I need to find out which lists have Selective Access. There are two ways to do that:

1. Export "Users" page and extract list name from columns.
2. Use "Retrieve list metadata" for each list from "Retrieve lists".

The first approach is more time-efficient, but requires creation of Export Action in advance.

My idea is to create "includeDetails" parameter to request. Similar parameters exist in "Retrieve models", "List workspaces" and other Endpoints.

The output for request with "includeDetails=true" as I see it:

[
  {
    "id": "101000000000",
    "name": "Organization",
    "metadata": {
      …
    }
  },
  {
    "id": "101000000001",
    "name": "opportunities",
    "metadata": {
      …
    }
  },
]

If you are reading this and have any suggestions on how this Idea can be even better, feel free to share.