Field API names

Within the Stacker API, fields are accessed via their API Names.

Getting the API Names from the Endpoint

The easiest way to get the API for a given field is by calling Fields endpoint.

Constructing an API Name

The API Name for a field is constructed from the unique code for the object associated (e.g. projects10) and the field's Developer Name (e.g. created_by), joined with two underscores: projects10__created_by.

While API Names are currently constructed in this way, this may change in the future. It is not recommended to construct names in this way directly, but instead to refer to names found from the Fields endpoint.

API Names

Field API names can be found by selecting Fields, then search for the field and hover over the field name to show the API name.