Description
Retrieves all workflow steps for the specified entry, including the current step status and details about each step.
Authentication
For available methods to authenticate to the API, refer to our REST API v1 Authentication guide.
The capability gravityflow_create_steps is required to access this endpoint.
This can be filtered using the gravityflow_web_api_capability_get_entries_steps filter.
Using the Endpoint
GET /gravityformsapi/entries/{entry_id}/steps
Required Parameters
| Key | Type | Description |
|---|---|---|
| entry_id | integer | The ID of the entry. |
Optional Parameters
None
Response
Success
A JSON array of step objects.
Object Properties
| Key | Description |
|---|---|
| id | The ID of the step. |
| type | The step type (e.g., approval, user_input). |
| label | The step label. |
| name | The step name. |
| is_current_step | Indicating the current step. |
| is_active | Indicating the step is active. |
| supports_expiration | Indicating if the step supports expiration. |
| assignees | Assignees for this step. |
| settings | Step settings. |
| status | The status of the step (e.g., pending, complete). |
| expiration_timestamp | Timestamp for when the step expires. |
| is_expired | Indicating if the step is expired. |
| is_queued | Indicating if the step has expired. |
| entry_count | Indicates if the step is queued. |
Failure
If the request fails, an error status code with a message will be returned.
Usage
cURL Request
curl "https://{domain}/gravityformsapi/entries/{entry_id}/steps?api_key={api_key}&signature={signature}&expires={timestamp}"
PHP Request
$response = wp_remote_get( 'https://{domain}/gravityformsapi/entries/{entry_id}/steps?api_key={api_key}&signature={signature}&expires={timestamp}' );
if ( ! is_wp_error( $response ) ) {
if ( 200 == wp_remote_retrieve_response_code( $response ) ) {
$body = wp_remote_retrieve_body( $response );
$steps = json_decode( $body, true );
} else {
$error_message = wp_remote_retrieve_response_message( $response );
}
} else {
$error_message = $response->get_error_message();
}