Receive Emails: Contacts & audience

Count Contacts

Counts the contacts that match a filter. Read only.

POSThttps://g.sendcorex.com/v1command: count_contacts

Arguments

  • whereobjectoptional

    Filters: status, tags, domain, opens and clicks, dates and custom fields. Same format as the dashboard contacts.

  • maxnumberoptional

    Stop counting at this number, up to 100,000. Defaults to 10,000.

Quick start

import axios from 'axios';

const response = await axios.post(
  'https://g.sendcorex.com/v1',
  {
    commands: [
      {
        command: "count_contacts",
        args: {
          where: {
            status: "subscribed"
          }
        }
      }
    ]
  },
  { headers: { Authorization: process.env.SENDCOREX_TOKEN } },
);

const [result] = response.data.results;
if (result.type !== 'SUCCESS') throw new Error(`${result.code}: ${result.message}`);
console.log(result.data);

Response

{
  "type": "SUCCESS",
  "results": [
    {
      "command": "count_contacts",
      "id": "0",
      "type": "SUCCESS",
      "data": {
        "count": 1240,
        "exact": true
      }
    }
  ]
}

Response fields

  • count

    How many contacts matched.

  • exact

    false when the count stopped at max.

Errors

HTTP-level errors return type, code and message. Errors marked CMD come back inside the command result, with HTTP 200.

  • 401TOKEN_EXPIRED

    The access token has expired. Call Refresh Token and repeat the request.

  • 401INVALID_TOKEN

    The token is malformed, unknown or revoked.

  • 429RATE_LIMITED

    More than 15 requests/s or 15 in flight for the same IP + mailbox. Wait the number of seconds in Retry-After.

  • CMDINVALID_ARGS

    A required argument is missing or invalid.

  • CMDINTERNAL

    Server error. The detail is only written to the server log.