Get metadata on a single List's Fields
Returns metadata on the Fields available on a single List.
Use the returned Field IDs to request field data from the GET /v2/lists/{listId}/list-entries
endpoint.
You can filter Fields using the filter query parameter. The filter parameter is a string that you can specify conditions based on the following properties.
| Property Name | Type | Allowed Operators | Examples |
|---|---|---|---|
name | text | =, =~ | name="Status", name=~stat |
Use the includes query parameter to add optional metadata to each Field in the response. Pass includes more than once to request multiple values.
| Value | Adds to each Field |
|---|---|
filterability | How the field can be used in filter expressions on POST /v2/lists/{listId}/list-entries/search |
sortability | How the field can be used in sort expressions on that endpoint |
Example: GET /v2/lists/{listId}/fields?includes=filterability&includes=sortability
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
List ID
1 <= x <= 9007199254740991Query Parameters
Cursor for the next or previous page
"ICAgICAgYmVmb3JlOjo6Nw"
Number of items to include in the page
1 <= x <= 100100
Filter options
Additional properties to include in the response
filterability, sortability