API Docs
Voxbi Cockpit APIs
All endpoints

Get parsing settings for an import (user)

Returns the parsing settings that apply to this import's file type, each with its type, default, and current value. The client renders exactly these; CSV imports expose delimiter, enclosure, and input_encoding, while Excel imports expose sheet_index. Only an incomplete import can be read here (otherwise 409).

HTTP: bearerAuth

User bearer token. Default authentication for customer-facing endpoints. Obtain a token by calling POST /login with your credentials, then send it on every subsequent request as Authorization: Bearer <token>. The token inherits the permissions and PBX scope of the authenticated user.

HTTP Authorization Scheme
bearer
Bearer format
Bearer <token>
id path · string · uuid *
Import identifier
accept header · string
example: application/json

Responses

Response schema
keystring
example: input_encoding
typestring
enum: integer boolean string
example: string
defaultobject
Default value (type depends on `type`); may be null.
example: UTF-8
currentobject
Currently stored value; may be null.
allowed_valuesarray<string>
Present only for settings with a fixed value set (e.g. `input_encoding`).
[]string
Authorization Token Missing. This error is returned when the authorization token is missing.
Response schema
errorstring
Error message
example: Authorization Token is missing
Data Not Found. This error is returned when the requested data is not found.
Response schema
messagearray<string>
[]string
Conflict. The import is no longer in a state that allows this action (for example, it has already been submitted for processing). Only an `incomplete` import can be configured or confirmed.
Response schema
messagestring
Server error. An unexpected condition was encountered on the server and the request could not be completed. The body is a generic JSON envelope with a `message` field. The response is logged on the server side; quote the request URL + timestamp when reporting an issue.
Response schema
messagestring
exceptionstring
Only present in non-production environments.
filestring
Only present in non-production environments.
lineinteger
Only present in non-production environments.
get https://cockpit.voxbi.com/api/v1/contacts/imports/{id}/settings
Base URL
Request sample 
curl -X GET 'https://cockpit.voxbi.com/api/v1/contacts/imports/{id}/settings' \
  -H 'Authorization: Bearer YOUR_TOKEN'
const response = await fetch('https://cockpit.voxbi.com/api/v1/contacts/imports/{id}/settings', {
  method: 'GET',
  headers: {
    'Content-Type': 'application/json',
    'Authorization': `Bearer ${YOUR_TOKEN}`,
  },
});

const data = await response.json();
console.log(data);
import requests

response = requests.get('https://cockpit.voxbi.com/api/v1/contacts/imports/{id}/settings',
    headers={'Authorization': f'Bearer {YOUR_TOKEN}'}
)
response.raise_for_status()
data = response.json()
print(data)
<?php
$context = stream_context_create([
    'http' => [
        'method'  => 'GET',
        'header'  => "Content-Type: application/json\r\nAuthorization: Bearer YOUR_TOKEN",
    ],
]);

$response = file_get_contents('https://cockpit.voxbi.com/api/v1/contacts/imports/{id}/settings', false, $context);
$data = json_decode($response, true);
print_r($data);
[ … ]
{ … },
"key": "header_row_position",
"type": "integer",
"default": 1,
"current": 1
},
{ … },
"key": "skip_on_error",
"type": "boolean",
"default": true,
"current": true
},
{ … }
"key": "delimiter",
"type": "string",
"default": null,
"current": null
}
]
{ … }
"error": "Authorization Token is missing"
}
Cache-Control string
example: private, must-revalidate
Connection string
example: keep-alive
Content-Type string
example: application/json
Vary string
example: Origin
X-RateLimit-Limit integer
Max requests allowed in the current rate-limit window.
example: 60
X-RateLimit-Remaining integer
Requests remaining in the current rate-limit window.
example: 57
{ … }
"message": [ … ]
"Data not found"
]
}
Cache-Control string
example: private, must-revalidate
Connection string
example: keep-alive
Content-Type string
example: application/json
Vary string
example: Origin
X-RateLimit-Limit integer
Max requests allowed in the current rate-limit window.
example: 60
X-RateLimit-Remaining integer
Requests remaining in the current rate-limit window.
example: 57
{ … }
"message": "This import has already been submitted."
}
Content-Type string
example: application/json
{ … }
"message": "Server Error"
}