Quick Start

This guide walks you through distributing a survey to a contact using the REST API.

Prerequisites

A Fikrr account with API access enabled.
An API key (generate one under Settings > API Access).
A published survey (note the survey ID from the URL).

Steps

Create a contact

curl -X POST https://fikrr.diwakarmaurya.com/api/v1/contacts/upsert \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "projectId": "PROJECT_ID",
    "email": "jane@example.com",
    "firstName": "Jane",
    "lastName": "Doe"
  }'

Distribute the survey

curl -X POST https://fikrr.diwakarmaurya.com/api/v1/distributions/quick \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "projectId": "PROJECT_ID",
    "surveyId": "SURVEY_ID",
    "contacts": [{ "email": "jane@example.com" }],
    "channel": {
      "type": "email",
      "provider": "sendgrid",
      "subject": "We value your feedback",
      "templateId": "TEMPLATE_ID"
    }
  }'

Check response status

curl https://fikrr.diwakarmaurya.com/api/v1/responses/by-contacts \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "projectId": "PROJECT_ID",
    "surveyId": "SURVEY_ID",
    "contactEmails": ["jane@example.com"]
  }'

Next steps

Browse the full API Reference for all available endpoints.
Set up Webhooks for event-driven integrations.