Skip to main content
GET
Get a Single Data Key

Authorizations

Authorization
string
header
required

API key en el header Authorization: Basic TU_API_KEY. La key va tal cual, sin codificar en base64. Las credenciales se entregan al comenzar la integración.

Path Parameters

id
integer
required

Identifier of the Data Key you'd like to get.

Query Parameters

fields
string

Restrict the fields you wish to retrieve by listing the desired fields formatted as a comma-separated list. Fields like "object", "self", and "id" are always returned.

Response

default - application/json

successful operation

object
string

A string denoting the current resource being requested or affected.

Example:

"data_key"

self
string

The relative URL of the current resource being requested or affected.

Example:

"/v2/data-keys/1234"

id
integer
read-only

The current resource identifier (ID).

Example:

1234

name
string

The name of the data key. Must be unique. Names must be no longer than 32 characters.

Example:

"my_string"

type
string

The type of key (STRING, NUMBER, DATE, DATETIME, TIME).

Example:

"STRING"

in_use
boolean
read-only

Whether or not the data key is being used by a data key target. If the key is being used it cannot be modified or deleted.

Example:

true