Skip to main content

Prerequisites

Before you begin, you need:
  • An Amplify account with API access
  • An Amplify API key
  • A command-line HTTP client such as curl
Keep the API key and access token secret. Never expose either credential in browser code, public repositories, or client-side applications.
1

Store your API key

Store your API key in an environment variable so it does not appear directly in your source code.
2

Request an access token

Exchange the API key for an access token using the authentication endpoint.
A successful response contains the token at data.access_token, identifies its type as Bearer, and sets expires_in to 86400 seconds (24 hours).
3

Store the access token

Extract the access token with jq and store it for subsequent requests.
4

Make your first API request

Retrieve a list of phone numbers from the production API.
5

Inspect the response

A successful list response contains a data array and pagination metadata.
Save the meta.request_id value when troubleshooting a request.

Next steps

List numbers

Review filters and the complete response schema.

Authentication

Review the access-token flow and security guidance.

Requests and responses

Learn the shared request and response formats.