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
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
AskNicely

AskNicely Contacts API

Import, look up, deactivate and privacy-delete contacts.

Documentation Provider Profile APIs.io OpenAPI GitHub

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

Tagged areas include Contacts. 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 8 operations across 8 paths, and defines 13 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.

8 operations 8 paths 13 schemas 3 GET5 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
Contact
AskNicely Support
Terms of Service
View terms
Resource Areas
1

Authentication & Security 1

AskNicely Contacts 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 8

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

Contacts 8

Import, look up, deactivate and privacy-delete 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
GET
/contact/get/{search}/{key}
Get a contact
getContact 2 params → 200401429
GET
/contact/remove/{search}/{key}
Deactivate a contact
removeContact 2 params → 200401429
POST
/privacy/remove
Delete a contact's personal data (GDPR)
privacyRemoveContacts body → 200401429
GET
/contacts/unsubscribed
List unsubscribed contacts
getUnsubscribedContacts 2 params → 200401429
POST
/contacts/deactivateall
Deactivate all contacts
deactivateAllContacts → 200307401429
POST
/curlupload/{importerId}
Bulk add contacts by uploading a CSV to a configured importer
uploadContactsCsv 1 param body → 200401429

Schemas 13

The contract defines 13 schemas that model the data the API accepts and returns. The most detailed are Contact (11 properties), TriggerSurveyRequest (9 properties), UnsubscribedContact (3 properties), ContactRemovedEnvelope (3 properties). Each schema is shown below with its type and property counts.

UnsubscribedEnvelope
object
2 properties
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
PrivacyRemoveRequest
object
2 properties 1 required
ContactRemovedEnvelope
object
3 properties
UnsubscribedContact
object
3 properties
Contact
object
11 properties
ErrorEnvelope
object
The AskNicely error envelope. Not RFC 9457 Problem Details.
2 properties 2 required
ContactEnvelope
object
2 properties
TriggerSurveyResponse
object
3 properties
RateLimitError
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-contacts-api-openapi.yml Raw ↑

Other APIs AskNicely publishes across the network.

AskNicely MCP Server (Ask NiceAI)
AE Profile APIs.io
AskNicely In-App Surveys API
AE Profile APIs.io
AskNicely Responses API
AE Profile APIs.io
AskNicely Statistics API
AE Profile APIs.io
AskNicely Surveys API
AE Profile APIs.io
#Contacts
← Back to A APIs
API Details
ID
asknicely:asknicely-contacts-api
Base URL
https://demo.asknice.ly/api/v1
Docs
https://demo.asknice.ly/help/apidocs
Provider
AskNicely
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=asknicely-contacts-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/asknicely-contacts-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have. Your account

Where this information came from

This is an independent, third-party profile of AskNicely Contacts 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.