### Example Request to Get an Access Token Source: https://developers.videoask.com/ This cURL command demonstrates how to make the POST request to the token endpoint to obtain an access token. It includes all necessary parameters for the authorization code grant type. ```curl curl --location 'https://auth.videoask.com/oauth/token' \ --data-urlencode 'grant_type=authorization_code' \ --data-urlencode 'code={temporary_authorization_code}' \ --data-urlencode 'client_id={your_client_id}' \ --data-urlencode 'client_secret={your_client_secret}' \ --data-urlencode 'redirect_uri=https://your-example-app.com/callback' ``` -------------------------------- ### Get Thread Details (Deprecated) Source: https://developers.videoask.com/ This endpoint is deprecated and will be removed. Use alternative methods for retrieving thread information. ```bash GET /threads/ ``` -------------------------------- ### VideoAsk Callback URL with Authorization Code Source: https://developers.videoask.com/ This is an example of the redirect URL after a user grants access. It includes a temporary authorization code that your application will use to request an access token. ```plaintext https://your-example-app.com/callback?code={temporary_authorization_code} ``` -------------------------------- ### Get Contact Details (Deprecated) Source: https://developers.videoask.com/ This endpoint is deprecated and will be removed. Use alternative methods for retrieving contact information. ```bash GET /contacts/ ``` -------------------------------- ### Get Question Insights Source: https://developers.videoask.com/ Retrieves insights for a specific question, including answer counts and other relevant data. ```APIDOC ## GET /questions/{question_id}/insights ### Description Retrieves insights for a specific question. ### Method GET ### Endpoint /questions/{question_id}/insights ### Parameters #### Path Parameters - **question_id** (string) - Required - The ID of the question. ``` -------------------------------- ### Get an access token Source: https://developers.videoask.com/ Exchanges a temporary authorization code for an access token. This is a crucial step for authenticating API requests after the user has granted permissions. ```APIDOC ## POST /oauth/token ### Description Exchanges a temporary authorization code, client ID, client secret, and redirect URI for an access token. ### Method POST ### Endpoint https://auth.videoask.com/oauth/token ### Parameters #### Request Body - **grant_type** (string) - Required - Always set to `authorization_code`. - **code** (string) - Required - The temporary authorization code obtained from the authorization step. - **client_id** (string) - Required - Your unique VideoAsk client identifier. - **client_secret** (string) - Required - Your unique secret identifier for VideoAsk clients. - **redirect_uri** (string) - Required - The URL where the application should redirect. Must match the `redirect_uri` provided during API access request. ### Request Example ```curl curl --location 'https://auth.videoask.com/oauth/token' \ --data-urlencode 'grant_type=authorization_code' \ --data-urlencode 'code={temporary_authorization_code}' \ --data-urlencode 'client_id={your_client_id}' \ --data-urlencode 'client_secret={your_client_secret}' \ --data-urlencode 'redirect_uri=https://your-example-app.com/callback' ``` ### Response #### Success Response (200) This request does not return a response body or headers upon success. ``` -------------------------------- ### Get Form Contacts with Count Source: https://developers.videoask.com/ Retrieve contacts for a specific form, including the total count. Send the query-param 'with_count=1' to include the 'count' field. ```bash GET /forms/{{form_id}}/contacts?with_count=1 ``` -------------------------------- ### Get Contacts for a Form Source: https://developers.videoask.com/ Retrieves a list of contacts associated with a specific form. This endpoint is recommended for retrieving respondent counts. ```APIDOC ## GET /forms/{form_id}/contacts ### Description Retrieves a list of contacts associated with a specific form. ### Method GET ### Endpoint /forms/{form_id}/contacts ### Parameters #### Path Parameters - **form_id** (string) - Required - The ID of the form. ``` -------------------------------- ### Get Question Insights Source: https://developers.videoask.com/ Retrieve insights for a specific question, including answer counts and last answer details. This endpoint is recommended for retrieving question-specific data. ```bash GET /questions/{{question_id}}/insights ``` -------------------------------- ### Create a Folder Source: https://developers.videoask.com/ Creates a new folder. ```APIDOC ## POST /folders ### Description Creates a new folder. ### Method POST ### Endpoint /folders ``` -------------------------------- ### List Answers for a Question Source: https://developers.videoask.com/ Retrieve a list of answers for a specific question. It is recommended to always send 'offset' and 'limit' query parameters for pagination. ```bash GET /questions//answers ``` -------------------------------- ### List Forms Source: https://developers.videoask.com/ Retrieve a list of all forms. It is recommended to always send 'offset' and 'limit' query parameters for pagination. ```bash GET /forms ``` -------------------------------- ### VideoAsk Authorization URL Source: https://developers.videoask.com/ Construct the authorization URL to initiate the OAuth2 flow. This URL confirms your client ID and prompts the user to grant permissions. ```plaintext https://auth.videoask.com/authorize?response_type=code&audience=https://api.videoask.com/&client_id={your_client_id}&scope=openid%20profile%20email&redirect_uri=https://your-example-app.com/callback ``` -------------------------------- ### List Answers for a Question Source: https://developers.videoask.com/ Retrieves a list of answers for a specific question. This endpoint will be paginated. It is recommended to always send `offset` and `limit` query parameters. ```APIDOC ## GET /questions/{question_id}/answers ### Description Retrieves a list of answers for a specific question. This endpoint will be paginated. ### Method GET ### Endpoint /questions/{question_id}/answers ### Parameters #### Path Parameters - **question_id** (string) - Required - The ID of the question. #### Query Parameters - **limit** (integer) - Optional - The maximum number of answers to return. - **offset** (integer) - Optional - The number of answers to skip before starting to collect the result set. - **with_count** (integer) - Optional - If set to 1, the response will include the total count of answers. ``` -------------------------------- ### List Messages Source: https://developers.videoask.com/ Retrieve a list of messages. It is recommended to always send 'offset' and 'limit' query parameters for pagination. ```bash GET /messages ``` -------------------------------- ### List Forms Source: https://developers.videoask.com/ Retrieves a list of all forms. This endpoint will be paginated and may change response fields in the future. It is recommended to always send `offset` and `limit` query parameters. ```APIDOC ## GET /forms ### Description Retrieves a list of all forms. This endpoint is subject to upcoming changes regarding pagination and response fields. ### Method GET ### Endpoint /forms ### Parameters #### Query Parameters - **limit** (integer) - Optional - The maximum number of forms to return. - **offset** (integer) - Optional - The number of forms to skip before starting to collect the result set. - **with_count** (integer) - Optional - If set to 1, the response will include the total count of forms. ``` -------------------------------- ### Update a Folder Source: https://developers.videoask.com/ Updates an existing folder. ```APIDOC ## PUT /folders/{folder_id} ### Description Updates an existing folder. ### Method PUT ### Endpoint /folders/{folder_id} ### Parameters #### Path Parameters - **folder_id** (string) - Required - The ID of the folder to update. ``` -------------------------------- ### List Messages Source: https://developers.videoask.com/ Retrieves a list of messages. This endpoint will be paginated. It is recommended to always send `offset` and `limit` query parameters. ```APIDOC ## GET /messages ### Description Retrieves a list of messages. This endpoint will be paginated. ### Method GET ### Endpoint /messages ### Parameters #### Query Parameters - **limit** (integer) - Optional - The maximum number of messages to return. - **offset** (integer) - Optional - The number of messages to skip before starting to collect the result set. - **with_count** (integer) - Optional - If set to 1, the response will include the total count of messages. ``` -------------------------------- ### Request Access Token using Authorization Code Source: https://developers.videoask.com/ Use a POST request to exchange the temporary authorization code for an access token. Ensure all parameters, including client ID and secret, are correctly provided. ```curl curl --request POST \ --url https://auth.videoask.com/oauth/token \ --data-urlencode 'grant_type=authorization_code' \ --data-urlencode 'code={temporary_authorization_code}' \ --data-urlencode 'client_id={your_client_id}' \ --data-urlencode 'client_secret={your_client_secret}' \ --data-urlencode 'redirect_uri=https://your-example-app.com/callback' ``` -------------------------------- ### Delete a Folder Source: https://developers.videoask.com/ Deletes a folder. ```APIDOC ## DELETE /folders/{folder_id} ### Description Deletes a folder. ### Method DELETE ### Endpoint /folders/{folder_id} ### Parameters #### Path Parameters - **folder_id** (string) - Required - The ID of the folder to delete. ``` === COMPLETE CONTENT === This response contains all available snippets from this library. No additional content exists. Do not make further requests.