Clarity Contacts API
The contacts API from Clarity — 7 operation(s) for contacts.
The contacts API from Clarity — 7 operation(s) for contacts.
Every API here is available over the APIs.io API and to AI agents over MCP.
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.curl "https://apis.io/api/v1/apis/onclarity-com:onclarity-com-contacts-api"
curl "https://apis.io/api/v1/apis?limit=25"
Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
openapi: 3.2.0
info:
title: Fast Contacts API
version: 0.1.0
tags:
- name: Contacts
paths:
/api/v1/contacts:
post:
tags:
- Contacts
summary: Create Contact
description: Create a contact (recipient) in the current project.
operationId: create_contact_api_v1_contacts_post
security:
- HTTPBearer: []
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/CreateContactRequest'
responses:
'200':
description: Successful Response
content:
application/json:
schema: {}
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
get:
tags:
- Contacts
summary: List Contacts
description: List the current project's contacts (newest first).
operationId: list_contacts_api_v1_contacts_get
security:
- HTTPBearer: []
parameters:
- name: limit
in: query
required: false
schema:
anyOf:
- type: integer
- type: 'null'
title: Limit
- name: offset
in: query
required: false
schema:
type: integer
default: 0
title: Offset
responses:
'200':
description: Successful Response
content:
application/json:
schema: {}
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/api/v1/contacts/{contact_id}:
get:
tags:
- Contacts
summary: Get Contact
description: Get a single contact by id.
operationId: get_contact_api_v1_contacts__contact_id__get
security:
- HTTPBearer: []
parameters:
- name: contact_id
in: path
required: true
schema:
type: string
title: Contact Id
responses:
'200':
description: Successful Response
content:
application/json:
schema: {}
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
patch:
tags:
- Contacts
summary: Update Contact
description: Update a contact's email/name/attributes.
operationId: update_contact_api_v1_contacts__contact_id__patch
security:
- HTTPBearer: []
parameters:
- name: contact_id
in: path
required: true
schema:
type: string
title: Contact Id
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateContactRequest'
responses:
'200':
description: Successful Response
content:
application/json:
schema: {}
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
delete:
tags:
- Contacts
summary: Delete Contact
description: Soft-delete a contact.
operationId: delete_contact_api_v1_contacts__contact_id__delete
security:
- HTTPBearer: []
parameters:
- name: contact_id
in: path
required: true
schema:
type: string
title: Contact Id
responses:
'200':
description: Successful Response
content:
application/json:
schema: {}
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/api/v1/contacts/import:
post:
tags:
- Contacts
summary: Import Contacts
description: 'Bulk import contacts from a CSV/XLSX file.
Expects an ``email`` column (required) and an optional ``name`` column; all
other columns are stored as the contact''s ``attributes``. Existing contacts
(matched on email) are updated, new ones created. Pass an optional
``contact_list_id`` form field to attach every imported contact to a list.
Parsing stays local (reuses the survey-import CSV/XLSX parser + its
size/row limits); only the resulting rows are sent to survey-api.
Returns:
A summary ``{created, updated, skipped, errors}``.
Raises:
HTTPException: 400 if the file is empty/malformed or lacks an ``email`` column.'
operationId: import_contacts_api_v1_contacts_import_post
requestBody:
content:
multipart/form-data:
schema:
$ref: '#/components/schemas/Body_import_contacts_api_v1_contacts_import_post'
required: true
responses:
'200':
description: Successful Response
content:
application/json:
schema: {}
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
security:
- HTTPBearer: []
/api/v1/contact-lists:
get:
tags:
- Contacts
summary: List Contact Lists
description: List the current project's contact lists (newest first).
operationId: list_contact_lists_api_v1_contact_lists_get
responses:
'200':
description: Successful Response
content:
application/json:
schema: {}
security:
- HTTPBearer: []
post:
tags:
- Contacts
summary: Create Contact List
description: Create a contact list (audience).
operationId: create_contact_list_api_v1_contact_lists_post
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/CreateContactListRequest'
required: true
responses:
'200':
description: Successful Response
content:
application/json:
schema: {}
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
security:
- HTTPBearer: []
/api/v1/contact-lists/{contact_list_id}:
get:
tags:
- Contacts
summary: Get Contact List
description: Get a contact list with its members.
operationId: get_contact_list_api_v1_contact_lists__contact_list_id__get
security:
- HTTPBearer: []
parameters:
- name: contact_list_id
in: path
required: true
schema:
type: string
title: Contact List Id
responses:
'200':
description: Successful Response
content:
application/json:
schema: {}
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
patch:
tags:
- Contacts
summary: Update Contact List
description: Update a contact list's name/description.
operationId: update_contact_list_api_v1_contact_lists__contact_list_id__patch
security:
- HTTPBearer: []
parameters:
- name: contact_list_id
in: path
required: true
schema:
type: string
title: Contact List Id
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateContactListRequest'
responses:
'200':
description: Successful Response
content:
application/json:
schema: {}
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
delete:
tags:
- Contacts
summary: Delete Contact List
description: Soft-delete a contact list.
operationId: delete_contact_list_api_v1_contact_lists__contact_list_id__delete
security:
- HTTPBearer: []
parameters:
- name: contact_list_id
in: path
required: true
schema:
type: string
title: Contact List Id
responses:
'200':
description: Successful Response
content:
application/json:
schema: {}
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/api/v1/contact-lists/{contact_list_id}/add-members:
post:
tags:
- Contacts
summary: Add Contact List Members
description: Attach contacts to a list (idempotent — already-attached contacts are skipped).
operationId: add_contact_list_members_api_v1_contact_lists__contact_list_id__add_members_post
security:
- HTTPBearer: []
parameters:
- name: contact_list_id
in: path
required: true
schema:
type: string
title: Contact List Id
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/ContactListMembersRequest'
responses:
'200':
description: Successful Response
content:
application/json:
schema: {}
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/api/v1/contact-lists/{contact_list_id}/remove-members:
post:
tags:
- Contacts
summary: Remove Contact List Members
description: Detach contacts from a list.
operationId: remove_contact_list_members_api_v1_contact_lists__contact_list_id__remove_members_post
security:
- HTTPBearer: []
parameters:
- name: contact_list_id
in: path
required: true
schema:
type: string
title: Contact List Id
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/ContactListMembersRequest'
responses:
'200':
description: Successful Response
content:
application/json:
schema: {}
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
components:
schemas:
UpdateContactListRequest:
properties:
name:
anyOf:
- type: string
- type: 'null'
title: Name
description:
anyOf:
- type: string
- type: 'null'
title: Description
type: object
title: UpdateContactListRequest
ContactListMembersRequest:
properties:
contact_ids:
items:
type: string
type: array
title: Contact Ids
type: object
required:
- contact_ids
title: ContactListMembersRequest
ValidationError:
properties:
loc:
items:
anyOf:
- type: string
- type: integer
type: array
title: Location
msg:
type: string
title: Message
type:
type: string
title: Error Type
input:
title: Input
ctx:
type: object
title: Context
type: object
required:
- loc
- msg
- type
title: ValidationError
UpdateContactRequest:
properties:
email:
anyOf:
- type: string
pattern: ^[a-zA-Z0-9_.+-]+@[a-zA-Z0-9-]+\.[a-zA-Z0-9-.]+$
- type: 'null'
title: Email
name:
anyOf:
- type: string
- type: 'null'
title: Name
phone:
anyOf:
- type: string
- type: 'null'
title: Phone
attributes:
anyOf:
- additionalProperties: true
type: object
- type: 'null'
title: Attributes
type: object
title: UpdateContactRequest
CreateContactRequest:
properties:
email:
type: string
pattern: ^[a-zA-Z0-9_.+-]+@[a-zA-Z0-9-]+\.[a-zA-Z0-9-.]+$
title: Email
name:
anyOf:
- type: string
- type: 'null'
title: Name
phone:
anyOf:
- type: string
- type: 'null'
title: Phone
attributes:
anyOf:
- additionalProperties: true
type: object
- type: 'null'
title: Attributes
type: object
required:
- email
title: CreateContactRequest
CreateContactListRequest:
properties:
name:
type: string
title: Name
description:
anyOf:
- type: string
- type: 'null'
title: Description
type: object
required:
- name
title: CreateContactListRequest
HTTPValidationError:
properties:
detail:
items:
$ref: '#/components/schemas/ValidationError'
type: array
title: Detail
type: object
title: HTTPValidationError
Body_import_contacts_api_v1_contacts_import_post:
properties:
file:
type: string
contentMediaType: application/octet-stream
title: File
contact_list_id:
anyOf:
- type: string
- type: 'null'
title: Contact List Id
type: object
required:
- file
title: Body_import_contacts_api_v1_contacts_import_post
securitySchemes:
HTTPBearer:
type: http
scheme: bearer
HTTPBasic:
type: http
scheme: basic