[[index-patterns-runtime-field-api-get]]
=== Get runtime field API
++++
<titleabbrev>Get runtime field</titleabbrev>
++++

experimental[] Get a runtime field

[[index-patterns-runtime-field-get-request]]
==== Request

`GET <kibana host>:<port>/api/index_patterns/index_pattern/<index_pattern_id>/runtime_field/<name>`

`GET <kibana host>:<port>/s/<space_id>/api/index_patterns/index_pattern/<index_pattern_id>/runtime_field/<name>`

[[index-patterns-runtime-field-get-params]]
==== Path parameters

`space_id`::
(Optional, string) An identifier for the space. If `space_id` is not provided in the URL, the default space is used.

`index_pattern_id`::
(Required, string) The ID of the index pattern.

`name`::
(Required, string) The name of the runtime field you want to retrieve.


[[index-patterns-runtime-field-get-example]]
==== Example

Retrieve a runtime field named `foo` of index pattern with the `my-pattern` ID:

[source,sh]
--------------------------------------------------
$ curl -X GET api/index_patterns/index_pattern/my-pattern/runtime_field/foo
--------------------------------------------------
// KIBANA

The API returns a runtime `field` object, and a `runtimeField` definition object:

[source,sh]
--------------------------------------------------
{
    "field": {
        ...
    },
    "runtimeField": {
        ...
    }
}
--------------------------------------------------
