Skip to main content
GET
/
v1
/
lists
Get lists
curl --request GET \
  --url https://openapi.genesy.ai/v1/lists \
  --header 'x-api-key: <api-key>'
{
  "data": [
    {
      "id": 123,
      "name": "<string>",
      "description": "<string>",
      "type": "CONTACTS",
      "entitiesCount": 123,
      "createdBy": {
        "id": 123,
        "name": "<string>"
      },
      "createdAt": "2023-12-25"
    }
  ],
  "meta": {
    "page": 123,
    "pageSize": 123,
    "total": 123
  }
}

Authorizations

x-api-key
string
header
required

Query Parameters

page
string
default:1

Page number for pagination. Minimum value is 1. Defaults to 1.

pageSize
string
default:25

Number of items per page. Minimum is 1, maximum is 100. Defaults to 25.

Search term to filter lists by name or description (case-insensitive).

type
enum<string>

Filter lists by type (CONTACTS or COMPANIES).

Available options:
CONTACTS,
COMPANIES

Response

200 - application/json

Successful response with paginated lists

data
object[]
required
meta
object
required