Skip to main content
GET
/
v1
/
folders
/
contacts
/
{folderId}
Get contact list folder
curl --request GET \
  --url https://openapi.enginy.ai/v1/folders/contacts/{folderId} \
  --header 'x-api-key: <api-key>'
{
  "status": "success",
  "message": "<string>",
  "data": {
    "id": 123,
    "name": "<string>",
    "parentId": 123,
    "type": "CONTACTS",
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z",
    "listsCount": 123,
    "subfoldersCount": 123,
    "children": [
      {
        "id": 123,
        "name": "<string>",
        "_count": {
          "children": 123,
          "leadsGroup": 123,
          "companyGroup": 123
        }
      }
    ],
    "parent": {
      "id": 123,
      "name": "<string>"
    },
    "ancestors": [
      {
        "id": 123,
        "name": "<string>",
        "parentId": 123
      }
    ],
    "totalSubfoldersCount": 123,
    "totalListsCount": 123,
    "leadsGroup": [
      {
        "id": 123,
        "name": "<string>",
        "description": "<string>",
        "folderId": 123,
        "createdAt": "2023-11-07T05:31:56Z",
        "updatedAt": "2023-11-07T05:31:56Z",
        "createdBy": {
          "id": 123,
          "name": "<string>"
        },
        "_count": {
          "leadsGroupLeads": 123
        }
      }
    ],
    "companyGroup": [
      {
        "id": 123,
        "name": "<string>",
        "description": "<string>",
        "folderId": 123,
        "createdAt": "2023-11-07T05:31:56Z",
        "updatedAt": "2023-11-07T05:31:56Z",
        "createdBy": {
          "id": 123,
          "name": "<string>"
        },
        "_count": {
          "companyGroupCompany": 123
        }
      }
    ]
  }
}

Authorizations

x-api-key
string
header
required

Path Parameters

folderId
string
required

Folder ID

Response

Folder retrieved successfully

status
enum<string>
required
Available options:
success
message
string
required
data
object
required