Search for Lists

get https://api.g001.enterprise.ipost.com/v1/{ClientToken}/lists/search/

Retrieve List information

Path Params

ClientToken

string

required

Client-specific Identification String

Query Params

ListName

string

Defaults to Optional

It will search the lists matched with Full or substring of ListName.

ListType

string

Defaults to Optional

The value should be "Static", "Test" or "Dynamic".

ListDescription

string

Defaults to Optional

It will search the lists matched with Full or substring of ListDescription.

ListCreationTimeBefore

date

Defaults to Optional) YYYY-MM-DD HH:MM:SS

It will return all the lists created before the specified DateTime.

ListCreateTimeAfter

date

Defaults to Optional) YYYY-MM-DD HH:MM:SS

It will return all the lists created after the specified DateTime.

ListFolderID

int32

Defaults to null

The list is available under the given FolderID.

Public

boolean

Defaults to false

If the value of Public is True, it will show all the Public lists similarly for Private property.

Headers

X-Auth-Token

string

required

Auth_token

Response

Language

Request


xxxxxxxxxx
1
curl --request GET \
2
     --url 'https://api.g001.enterprise.ipost.com/v1/ClientToken/lists/search/?ListName=Optional&ListType=Optional&ListDescription=Optional&ListCreationTimeBefore=Optional%29%20YYYY-MM-DD%20HH%3AMM%3ASS&ListCreateTimeAfter=Optional%29%20YYYY-MM-DD%20HH%3AMM%3ASS&ListFolderID=null&Public=false' \
3
     --header 'accept: application/json'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200200