github.com/twilio/twilio-go@v1.20.1/rest/studio/v1/docs/FlowsEngagementsStepsApi.md (about)

     1  # FlowsEngagementsStepsApi
     2  
     3  All URIs are relative to *https://studio.twilio.com*
     4  
     5  Method | HTTP request | Description
     6  ------------- | ------------- | -------------
     7  [**FetchStep**](FlowsEngagementsStepsApi.md#FetchStep) | **Get** /v1/Flows/{FlowSid}/Engagements/{EngagementSid}/Steps/{Sid} | 
     8  [**ListStep**](FlowsEngagementsStepsApi.md#ListStep) | **Get** /v1/Flows/{FlowSid}/Engagements/{EngagementSid}/Steps | 
     9  
    10  
    11  
    12  ## FetchStep
    13  
    14  > StudioV1Step FetchStep(ctx, FlowSidEngagementSidSid)
    15  
    16  
    17  
    18  Retrieve a Step.
    19  
    20  ### Path Parameters
    21  
    22  
    23  Name | Type | Description
    24  ------------- | ------------- | -------------
    25  **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
    26  **FlowSid** | **string** | The SID of the Flow with the Step to fetch.
    27  **EngagementSid** | **string** | The SID of the Engagement with the Step to fetch.
    28  **Sid** | **string** | The SID of the Step resource to fetch.
    29  
    30  ### Other Parameters
    31  
    32  Other parameters are passed through a pointer to a FetchStepParams struct
    33  
    34  
    35  Name | Type | Description
    36  ------------- | ------------- | -------------
    37  
    38  ### Return type
    39  
    40  [**StudioV1Step**](StudioV1Step.md)
    41  
    42  ### Authorization
    43  
    44  [accountSid_authToken](../README.md#accountSid_authToken)
    45  
    46  ### HTTP request headers
    47  
    48  - **Content-Type**: Not defined
    49  - **Accept**: application/json
    50  
    51  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
    52  [[Back to Model list]](../README.md#documentation-for-models)
    53  [[Back to README]](../README.md)
    54  
    55  
    56  ## ListStep
    57  
    58  > []StudioV1Step ListStep(ctx, FlowSidEngagementSidoptional)
    59  
    60  
    61  
    62  Retrieve a list of all Steps for an Engagement.
    63  
    64  ### Path Parameters
    65  
    66  
    67  Name | Type | Description
    68  ------------- | ------------- | -------------
    69  **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
    70  **FlowSid** | **string** | The SID of the Flow with the Step to read.
    71  **EngagementSid** | **string** | The SID of the Engagement with the Step to read.
    72  
    73  ### Other Parameters
    74  
    75  Other parameters are passed through a pointer to a ListStepParams struct
    76  
    77  
    78  Name | Type | Description
    79  ------------- | ------------- | -------------
    80  **PageSize** | **int** | How many resources to return in each list page. The default is 50, and the maximum is 1000.
    81  **Limit** | **int** | Max number of records to return.
    82  
    83  ### Return type
    84  
    85  [**[]StudioV1Step**](StudioV1Step.md)
    86  
    87  ### Authorization
    88  
    89  [accountSid_authToken](../README.md#accountSid_authToken)
    90  
    91  ### HTTP request headers
    92  
    93  - **Content-Type**: Not defined
    94  - **Accept**: application/json
    95  
    96  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
    97  [[Back to Model list]](../README.md#documentation-for-models)
    98  [[Back to README]](../README.md)
    99