# getKey

Returns the key (id field) of a given entity, either simple or composite keys.

* If the key is a simple pk then it will return a string, if it is a composite key then it returns an array.
* If the key cannot be identified then a blank string is returned.

## Returns

* This function returns *any*

## Arguments

| Key    | Type   | Required | Default | Description                      |
| ------ | ------ | -------- | ------- | -------------------------------- |
| entity | string | Yes      | ---     | The entity name or entity object |

## Examples

```javascript
var pkField = ormService.getKey( "User" );
```


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://coldbox-orm.ortusbooks.com/base-orm-service/service-methods/entity-convenience-methods/getkey.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.