> ## Documentation Index
> Fetch the complete documentation index at: https://docs.revoengine.com/llms.txt
> Use this file to discover all available pages before exploring further.

# api.input()

> Public low-code contract, signatures and examples for api.input.

## `api.input()`

Returns the current execution payload.

Notes:

* In endpoint context this usually includes body, query, headers, params, path, and method.
* In event or job context it commonly includes type and message.
* Passing a name returns a single top-level property.

### Signature

```ts theme={null}
static input(name?: string): Input;
```

### Example

```ts theme={null}
const customerId = api.input()?.body?.customerId;
```

See [all api methods](https://docs.revoengine.com/low-code/reference/api.md) or [runtime basics](https://docs.revoengine.com/low-code/overview.md).


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.