← API Reference

CRM API

Contacts, leads, scoring, forms, tracking

Base URL: https://crm-api.ayoune.app — 24 entities

Example

cURL

curl -H "Authorization: Bearer pat_your_token" \
  https://crm-api.ayoune.app/activities?limit=10

TypeScript SDK

import { aYOUne } from '@tolinax/ayoune';
const ay = new aYOUne('pat_your_token');

const result = await ay.crm.activities.find().limit(10).exec();
console.log(result.payload());

Entities

Entity	REST Path	SDK	Access	Right
Activities	/activities	ay.crm.activities	CRUD	crm.activities	play_circle
CalendarEntries	/calendarentries	ay.crm.calendarEntries	CRUD	crm.calendarentries	play_circle
CheckLists	/checklists	ay.crm.checkLists	CRUD	crm.checklists	play_circle
ConsumerDatabases	/consumerdatabases	ay.crm.consumerDatabases	read-only	crm.consumerdatabases	play_circle
ConsumerHooks	/consumerhooks	ay.crm.consumerHooks	CRUD	crm.consumerhooks	play_circle
ConsumerLists	/consumerlists	ay.crm.consumerLists	CRUD	crm.consumerlists	play_circle
ConsumerNotifications	/consumernotifications	ay.crm.consumerNotifications	read-only	crm.consumernotifications	play_circle
Consumers	/consumers	ay.crm.consumers	CRUD	crm.consumers	play_circle
DataCollectionEntries	/datacollectionentries	ay.crm.dataCollectionEntries	CRUD	crm.datacollectionentries	play_circle
Documents	/documents	ay.crm.documents	CRUD	crm.documents	play_circle
Drafts	/drafts	ay.crm.drafts	CRUD	crm.drafts	play_circle
Enrichments	/enrichments	ay.crm.enrichments	CRUD	crm.enrichments	play_circle
FormSubmissions	/formsubmissions	ay.crm.formSubmissions	read-only	crm.formsubmissions	play_circle
ImapMails	/imapmails	ay.crm.imapMails	read-only	crm.imapmails	play_circle
Leads	/leads	ay.crm.leads	CRUD	crm.leads	play_circle
Messages	/messages	ay.crm.messages	CRUD	crm.messages	play_circle
Notifications	/notifications	ay.crm.notifications	CRUD	crm.notifications	play_circle
OutgoingMails	/outgoingmails	ay.crm.outgoingMails	read-only	crm.outgoingmails	play_circle
Segments	/segments	ay.crm.segments	CRUD	crm.segments	play_circle
SelectionResults	/selectionresults	ay.crm.selectionResults	CRUD	crm.selectionresults	play_circle
SelectionResultsBuckets	/selectionresultsbuckets	ay.crm.selectionResultsBuckets	CRUD	crm.selectionresultsbuckets	play_circle
Selections	/selections	ay.crm.selections	CRUD	crm.selections	play_circle
UserSegments	/usersegments	ay.crm.userSegments	CRUD	crm.usersegments	play_circle
XingContacts	/xingcontacts	ay.crm.xingContacts	CRUD	crm.xingcontacts	play_circle