GetKeyValueItems | Voximplant Voice AI

Gets all the key-value pairs in which the keys begin with a pattern.

Allowed roles: Owner, Admin, Developer.

Example request: GetKeyValueItems example.

Gets all the key-value pairs in which the keys begin with a pattern.

Allowed roles: Owner, Admin, Developer.

Example request: GetKeyValueItems example.

Authentication

AuthorizationBearer

Voximplant Management API uses signed JWT tokens generated from your service-account private key. Pass the token in the Authorization header as a Bearer value:

Authorization: Bearer $VOXIMPLANT_TOKEN

See Authorization for ready-to-copy snippets in bash, Python, Node.js and Go that turn your credentials.json into a token.

Query parameters

keystringRequired

Namespace that keys should contain, up to 200 characters

countintegerOptional

Number of items to show per page with a maximum value of 50. Default value is 10

offsetintegerOptional

Number of items to skip (e.g. if you set count = 20 and offset = 0 the first time, the next time, offset has to be equal to 20 to skip the items shown earlier). Default value is 0

application_idintegerRequired

The application ID

application_namestringOptional

The application name

Response

Successful response

resultlist of objects

The key-value pairs

Voximplant Management API uses signed JWT tokens generated from your service-account private key. Pass the token in the Authorization header as a Bearer value:

Authorization: Bearer $VOXIMPLANT_TOKEN

See Authorization for ready-to-copy snippets in bash, Python, Node.js and Go that turn your credentials.json into a token.

Namespace that keys should contain, up to 200 characters

Number of items to show per page with a maximum value of 50. Default value is 10

Number of items to skip (e.g. if you set count = 20 and offset = 0 the first time, the next time, offset has to be equal to 20 to skip the items shown earlier). Default value is 0

The application name

1	{
2	"result": [
3	{
4	"key": "test",
5	"value": "value1",
6	"expires_at": 1606346632
7	},
8	{
9	"key": "test:1",
10	"value": "value2",
11	"expires_at": 1606846632
12	}
13	]
14	}

1	{
2	"result": [
3	{
4	"key": "test",
5	"value": "value1",
6	"expires_at": 1606346632
7	},
8	{
9	"key": "test:1",
10	"value": "value2",
11	"expires_at": 1606846632
12	}
13	]
14	}

$	curl -X POST "https://api.voximplant.com/platform_api/GetKeyValueItems?key=key&application_id=1" \
>	-H "Authorization: Bearer <token>"