curl --request GET \
--url https://api.callva.io/api/v1/external/custom-fields \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.callva.io/api/v1/external/custom-fields"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.callva.io/api/v1/external/custom-fields', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"success": true,
"message": "Custom field definitions retrieved successfully",
"data": [
"<unknown>"
]
}{
"success": false,
"message": "This API token is tenant-scoped. Please provide project_id in the request payload or query parameters, or use a project-scoped token.",
"code": "PROJECT_REQUIRED"
}{
"error": "Invalid or expired token",
"message": "The provided token is invalid or has expired"
}{
"success": false,
"message": "Insufficient permission.",
"code": "insufficient_permission"
}List custom fields
Requires permission: any one of calls.read, fields.create, fields.update, fields.delete, field_groups.create, field_groups.update, field_groups.delete. The answer carries field definitions only, never call data.
What a token may call depends on its role: see Authentication and permissions. Guide: Custom fields.
Get all custom field definitions for an entity type.
curl --request GET \
--url https://api.callva.io/api/v1/external/custom-fields \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.callva.io/api/v1/external/custom-fields"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.callva.io/api/v1/external/custom-fields', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"success": true,
"message": "Custom field definitions retrieved successfully",
"data": [
"<unknown>"
]
}{
"success": false,
"message": "This API token is tenant-scoped. Please provide project_id in the request payload or query parameters, or use a project-scoped token.",
"code": "PROJECT_REQUIRED"
}{
"error": "Invalid or expired token",
"message": "The provided token is invalid or has expired"
}{
"success": false,
"message": "Insufficient permission.",
"code": "insufficient_permission"
}Authorizations
A CallVA API token, sent as Authorization: Bearer <token>.
Creating one. In the CallVA dashboard, open the organization's Settings, then API Keys, and choose Create API Key: give the key a name, choose its role, and choose its project scope - All projects for an organization-wide token, or one project for a project token. The key is shown once, when it is created, and cannot be read again; store it then. Creating keys needs the api_tokens.create permission, which owners and admins hold, and a key cannot create another key.
Organization-wide or project token. A project token works in the one project it was created for; any project named in the request is ignored. An organization-wide token reaches the projects of its organization, and each request names its project with the X-Project-ID header or project_id (query string for reads and deletes, body for writes).
What it can call. The token's role decides which endpoints it may call; each endpoint names the permission it requires, and a token whose role lacks it is answered 403.
Headers
The project this request acts in. Required with an organization-wide token (or send project_id instead); ignored with a project token, which always acts in its own project.