# List VBAGatewaySubscription

Lists all VBAGatewaySubscription

Endpoint: GET /vbagateway-subscriptions
Version: v1
Security: apiKeyAuth, bearerAuth

## Header parameters:

  - `vbasoftware-database` (string, required)
    Target database

## Query parameters:

  - `sortBy` (string)
    Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., 'Property1:desc,Property2:asc,Property3:asc' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.

  - `page` (integer)
    Page

  - `pageSize` (integer)
    Page Size

## Response 200 fields (text/plain):

  - `data` (array,null)

  - `data.vbaGatewaySubscription_Key` (integer, required)
    ID of the VBAGateway subscription. Note: This field is marked as NOT NULL in the database and therefore required by the API.

  - `data.auto_Process` (boolean, required)
    Indicates that the requests associated with this subscription will be automatically processed. Note: This field is marked as NOT NULL in the database and therefore required by the API.

  - `data.auto_Process_Custom_Class` (string,null)
    Custom class associated with the auto-process request

  - `data.auto_Process_Response_Message` (string,null)
    Free text area where the message that will be sent as a response to auto-processed requests.

  - `data.auto_Process_Status` (string,null)
    Indicates the status that will be assigned to auto-processed requests.

  - `data.entry_Date` (string)
    Date record was first added to the system

  - `data.entry_User` (string,null)
    User that first added the record to the system

  - `data.idCard_Request_Type` (string,null)
    Request type used when the process involves ID Card requests

  - `data.notify_Me` (boolean, required)
    Flag indicating the user would like to be notified regarding the request Note: This field is marked as NOT NULL in the database and therefore required by the API.

  - `data.request_From` (string,null)
    Indicates the beginning date for the date range of requests that will be associated with subscription.

  - `data.request_Source` (string,null)
    Indicates which terminal the subscription's requests will generate from.

  - `data.request_Status` (string,null)
    Indicates which request status will be associated with the subscription.

  - `data.request_Thru` (string,null)
    Indicates the ending date for the date range of requests that will be associated with subscription.

  - `data.request_Type` (string,null)
    Indicates which type of request will be associated with the subscription.

  - `data.subscription_Description` (string,null)
    Description of the VBAGateway subscription.

  - `data.subscription_Type` (string,null)
    Indicates the type of the VBAGateway subscription.

  - `data.update_Date` (string)
    Date the record was last updated in the system

  - `data.update_User` (string,null)
    User that last updated the record in the system

  - `data.user_ID` (string,null)
    ID of the User associated with the VBAGateway subscription.

  - `error` (object)

  - `error.detail` (string,null)
    A human-readable explanation specific to this occurrence of the problem.

  - `error.instance` (string,null)
    A URI reference that identifies the specific occurrence of the problem.It may
or may not yield further information if dereferenced.

  - `error.status` (integer)
    The HTTP status code([RFC7231], Section 6) generated by the origin server for
this occurrence of the problem.

  - `error.title` (string,null)
    A short, human-readable summary of the problem type.It SHOULD NOT change from
occurrence to occurrence of the problem, except for purposes of localization(e.g.,
using proactive content negotiation; see[RFC7231], Section 3.4).

  - `error.type` (string,null)
    A URI reference [RFC3986] that identifies the problem type. This specification
encourages that, when dereferenced, it provide human-readable documentation for
the problem type (e.g., using HTML [W3C.REC-html5-20141028]). When this member
is not present, its value is assumed to be "about:blank".

  - `debug` (object)

  - `debug.activityID` (string, required)


## Response 401 fields