Fields
Get All Fields
Retrieve Fields
This endpoint makes an HTTP GET request to retrieve a list of fields.
Request
The request does not require a request body. It simply makes a GET request to the endpoint {{url}}/v1/fields.
Response
The response will be a JSON object representing the list of fields. Below is a JSON schema representing the structure of the response:
{
"type": "object",
"properties": {
"fields": {
"type": "array",
"items": {
"type": "object",
"properties": {
"fieldId": {
"type": "string"
},
"name": {
"type": "string"
},
"type": {
"type": "string"
},
"description": {
"type": "string"
}
}
}
}
}
}
The fields array contains objects with fieldId, name, type, and description properties, representing the details of each field.
get/fields
Request
- Base URL: https://api.speakai.co/v1
- URL: https://api.speakai.co/v1/fields
- Auth: API key in header x-speakai-key and API key in header x-access-token
Response
Success
Changes
No recorded changes to this operation across all 2 revisions of this API.