Get lists - Enginy API Docs

Get lists

curl --request GET \
  --url https://openapi.enginy.ai/v1/lists \
  --header 'x-api-key: <api-key>'

{
  "data": [
    {
      "id": 123,
      "name": "<string>",
      "description": "<string>",
      "appUrl": "<string>",
      "entitiesCount": 123,
      "createdBy": {
        "id": 123,
        "name": "<string>"
      },
      "createdAt": "2023-11-07T05:31:56Z"
    }
  ],
  "meta": {
    "page": 123,
    "pageSize": 123,
    "total": 123
  }
}

GET

lists

Get lists

curl --request GET \
  --url https://openapi.enginy.ai/v1/lists \
  --header 'x-api-key: <api-key>'

{
  "data": [
    {
      "id": 123,
      "name": "<string>",
      "description": "<string>",
      "appUrl": "<string>",
      "entitiesCount": 123,
      "createdBy": {
        "id": 123,
        "name": "<string>"
      },
      "createdAt": "2023-11-07T05:31:56Z"
    }
  ],
  "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.

string

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

Show child attributes

Documentation Index

Authorizations

Query Parameters

Response