MepMail Docs

Read contacts in bulk

POST
/contacts/batch/get

MepMail extension: returns up to 1000 contacts by id or by email address in one request, in request order, optionally with their properties and topic subscriptions. Entries that match no contact are listed under missing instead of failing the call. One call counts as one request against the rate limit.

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

curl -X POST "https://example.com/contacts/batch/get" \  -H "Content-Type: application/json" \  -d '{    "contacts": [      {}    ]  }'
{  "object": "list",  "data": [    {      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",      "email": "string",      "first_name": "string",      "last_name": "string",      "created_at": "string",      "unsubscribed": true,      "properties": {        "property1": {          "type": "string",          "value": "string"        },        "property2": {          "type": "string",          "value": "string"        }      },      "topics": [        {          "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",          "name": "string",          "description": "string",          "subscription": "opt_in",          "explicit": true,          "visibility": "public"        }      ],      "object": "contact"    }  ],  "missing": [    {      "index": 0,      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",      "email": "string"    }  ]}