API Keys
List API Keys
API Reference
Built-in Tools
Custom Tools
Calls
Post-call Analysis
Phone Numbers
- GETRetrieve a paginated list of all phone numbers configured in your PIA Platform account
- POSTCreate a new phone number
- GETRetrieve detailed information about a specific phone number configuration
- DELRemove a phone number configuration from the PIA Platform
- PATCHUpdate the configuration of an existing phone number
Knowledge Bases
Knowledge Bases v2
Prompt Generation
Public Sharing
API Keys
List API Keys
List all API keys for the user
GET
/
v1
/
api-keys
{
"data": [
{
"created_at": "2024-01-01T00:00:00",
"expiration_date": "2024-12-31T23:59:59",
"key_id": "507f1f77bcf86cd799439011",
"name": "Development API Key",
"permissions": [
"read",
"write"
],
"revoked": false
}
],
"next_page_token": "<string>"
}
Response
200
application/json
Successful Response
List of API keys matching the query parameters
Unique identifier for this API key in the database
The descriptive name given to this API key
List of permission scopes granted to this API key
Timestamp when this API key will expire and become invalid
Timestamp when this API key was created
Identifier of the user who created this API key
Indicates if this API key has been manually revoked before its expiration date
Token for retrieving the next page of results. Null if there are no more results
{
"data": [
{
"created_at": "2024-01-01T00:00:00",
"expiration_date": "2024-12-31T23:59:59",
"key_id": "507f1f77bcf86cd799439011",
"name": "Development API Key",
"permissions": [
"read",
"write"
],
"revoked": false
}
],
"next_page_token": "<string>"
}