Skip to main content

Quickstart

Make your first call in a few minutes.

1. Generate an API key​

In your Metaventus workspace, open Admin center → API keys and create a secret key. Copy it somewhere safe — it is shown only once.

Creating keys requires a professional plan: on the free plan the API is not open.

At creation time you can restrict the key: scopes limiting which resources it reaches, IP address restriction, and an expiry date.

2. Make your first call​

List your contacts:

curl "https://api.metaventus.com/v1/entities?entity_type=contact&page=1&page_size=25" \
  -H "X-API-Key: YOUR_SECRET_KEY" \
  -H "Content-Type: application/json"

Response (example):

{
  "data": [
    {
      "id": "7f0d1c2e-…",
      "entity_type": "contact",
      "first_name": "Jane",
      "last_name": "Miller",
      "email": "jane@example.com",
      "lifecycle_stage": "lead",
      "lead_score": 12
    }
  ],
  "meta": { "total": 1, "page": 1, "page_size": 25 }
}

Responses are wrapped in data; paginated lists add a meta object carrying total, page and page_size.

3. Create your first contact​

curl -X POST "https://api.metaventus.com/v1/entities" \
  -H "X-API-Key: YOUR_SECRET_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "entity_type": "contact",
    "first_name": "Mary",
    "last_name": "Doyle",
    "email": "mary@example.com"
  }'

What next?​

Last updated on