Jump to Content

Home User Guides API Reference Changelog

API Reference

Home User Guides API Reference Changelog

Getting Started

Overview
Use our Postman Collection
Authentication
Errors
Versioning

Authentication

OAuth
- Create OAuth2 tokenpost

Calendars

Calendars
Holidays Templates
- List Holidays Templatesget
- Retrieve a Holidays Template.get

Email

Domains
Sender identities
Transactional Email
- Send Emailpost
Newsletters
Templates
Metrics
- Get Metricsget
- Get Clicked Urlsget
Activity Logs
- List email activity logsget
- Retrieve an email activity logs for a given message Id, and email address.get
Suppression Lists

People

Attributes
Segments
Contacts
Exports
Imports
- Get Importsget
- Get Importget

RCS API

Messages
- Send RCS messagepost
- Revoke a RCS messagedelete
Capabilities
- Capabilities Checkget
Events
- Send an eventpost

SMS API

Send
- Send SMSpost
Activity Logs
- List SMS activity logsget
- Retrieve details of a specific messageget
Reporting
Suppression Lists (Blacklist)
- List phone numbers added to the suppression list for unsubscribe reasons (stop).get
- Add a phone number to suppression list.post

Voice API

Call
- Make Callpost
Scheduled Calls
Voice Broadcasts
Voice Broadcasts Settings
Reporting
Activity Logs
- List calls activity logsget
- Retrieve an call activity logs for a given call Id.get

Webhooks

Webhooks
Events
- List Webhooks Events Typeget

Webhook Events

call.delivered.v1
- Voice Call Deliveredpost
call.failed.v1
- Voice Call Failedpost
call.recipient-completed.v1
- Voice Broadcast recipient completedpost
email.sent.v1
- Email sentpost
email.delivered.v1
- Email deliveredpost
email.failed.v1
- Email failedpost
email.clicked.v1
- Email clickedpost
email.opened.v1
- Email openedpost
email.complained.v1
- Email complainedpost
email.unsubscribed.v1
- Email unsubscribedpost
sms.incoming.v1
- Incoming SMSpost
sms.status.v1
- SMS status reportspost
rcs.server-event.v1
- RCS server eventpost
rcs.user-event.v1
- RCS user eventpost
rcs.user-message.v1
- RCS user messagepost

Powered by

Get Segment

get https://api.naxai.com/people/segments/{segmentId}

Retrieve a existing segment.

Language

Credentials

OAuth2

Bearer

Click Try It! to start a request and see the response here!