How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

AskNicely Surveys API

Trigger NPS/CSAT/5-Star surveys to contacts.

AskNicely Surveys API is one of 6 APIs that AskNicely publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Surveys. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, a getting-started guide, authentication docs, and a changelog.

This API exposes 2 operations across 2 paths, and defines 7 schemas. It is described by OpenAPI 3.2.0, at version v1.

Requests are made against a single base URL, https://{domain}.asknice.ly/api/v1.

2 operations 2 paths 7 schemas 2 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
v1
Base URL
https://demo.asknice.ly/api/v1
Authentication
API Key
Terms of Service
Resource Areas
1

Authentication & Security 1

AskNicely Surveys API declares 1 security scheme for authenticating requests. An API key is passed in the header as X-apikey (apiKeyAuth). By default, every request must be authenticated.

  • apiKeyAuth — The account API key, found in-platform under Settings API. Every AskNicely user is issued their own key; create a separate user to isolate API traffic. Sending…

Paths & Operations 2

Across 2 paths, the API surfaces 2 operations — 2 POST. Each is listed below with its method, path, parameters, and response codes.

Surveys 2

Trigger NPS/CSAT/5-Star surveys to contacts.

POST
/contact/trigger
Import a contact and trigger a survey
triggerSurvey body → 200401429
POST
/contacts/add
Bulk add or update contacts, optionally triggering surveys
bulkAddContacts body → 201400401429500

Schemas 7

The contract defines 7 schemas that model the data the API accepts and returns. The most detailed are TriggerSurveyRequest (9 properties), TriggerSurveyResponse (3 properties), BulkContact (3 properties), BulkAddRequest (2 properties). Each schema is shown below with its type and property counts.

SuccessEnvelope
object
2 properties 1 required
BulkContact
object
Additional properties are custom data fields (suffix c), and may carry an array of values for multi-value fields.
3 properties 1 required
ErrorEnvelope
object
The AskNicely error envelope. Not RFC 9457 Problem Details.
2 properties 2 required
RateLimitError
TriggerSurveyResponse
object
3 properties
TriggerSurveyRequest
object
Any additional properties are treated as custom data fields. AskNicely recommends suffixing custom field names with c (snakecase) to avoid collisions with rese…
9 properties 1 required
BulkAddRequest
object
2 properties 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

asknicely-surveys-api-openapi.yml Raw ↑

Other APIs AskNicely publishes across the network.

AskNicely MCP Server (Ask NiceAI)
AskNicely Contacts API
AskNicely In-App Surveys API
AskNicely Responses API
AskNicely Statistics API
Where this information came from

This is an independent, third-party profile of AskNicely Surveys API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.