API Fundamentals

Use the Communications Platform APIs to exchange information about messages, contacts, and owners.

The Communication Platform APIs are HTTP-based REST APIs. Request and response bodies use JSON.

Prerequisites

Before you begin:

• Review web programming concepts, including HTTP requests and responses.
• Prepare to send and process JSON data.
• Ask a platform administrator to retrieve an API key for your integration.

Get an API key

1. Sign in to Communications Platform with an account that has administrator permissions.
2. Open Preferences and locate the API Key.
3. Share the API key securely with the development team responsible for the integration.

API capabilities

The API supports:

• Creating, retrieving, updating, and deleting (CRUD) resources
• Data validation
• Pagination
• Filtering