InformlyInformly
Contacts
GET
/contacts

Authorization

BearerAuth
AuthorizationBearer <token>

API token obtained from the Informly dashboard

In: header

Query Parameters

page?integer

Page number (1-indexed)

Default1
Range1 <= value
pageSize?integer

Number of items per page (1-100)

Default20
Range1 <= value <= 100

Response Body

application/json

application/json

application/json

curl -X GET "http://api.informly.co/api/v1/contacts"
{
  "data": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "email": "string",
      "phone": "string",
      "contact": {
        "firstname": "string",
        "lastname": "string",
        "jobtitle": "string",
        "company": "string"
      },
      "segments": [
        {
          "segmentId": "f2f864fb-5d15-4f35-b9aa-83491924c4db",
          "assignedAt": "2019-08-24T14:15:22Z"
        }
      ],
      "organizationId": "7bc05553-4b68-44e8-b7bc-37be63c6d9e9",
      "createdAt": "2019-08-24T14:15:22Z",
      "updatedAt": "2019-08-24T14:15:22Z"
    }
  ],
  "meta": {
    "total": 0,
    "page": 0,
    "pageSize": 0,
    "totalPages": 0
  }
}
{
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "string",
    "details": [
      {
        "path": "string",
        "message": "string"
      }
    ]
  }
}
{
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "string",
    "details": [
      {
        "path": "string",
        "message": "string"
      }
    ]
  }
}

SDK

import { Informly } from "@informly/sdk";

const client = new Informly.Client({
  token: "YOUR_API_TOKEN",
});

const response = await client.contacts.listContacts({
  page: 1,
  pageSize: 20,
});

console.log(response);