# Datascope

DataScope is the ideal tool to get rid of paperwork, save time and collect data efficiently from the field. The platform allows your team to answer personalized mobile forms (even offline), from their phones or tablets.

- **Category:** forms & surveys
- **Auth:** API_KEY
- **Composio Managed App Available?** N/A
- **Tools:** 19
- **Triggers:** 0
- **Slug:** `DATASCOPE`
- **Version:** 20260312_00

## Tools

### Change Form Answer

**Slug:** `DATASCOPE_CHANGE_FORM_ANSWER`

Tool to change a specific answer in a submitted form. Use when you need to modify question values after a form has been submitted.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `form_code` | string | Yes | Code of the form response/submission to modify. |
| `form_name` | string | Yes | Name or ID of the form containing the answer to change. |
| `question_name` | string | Yes | Name of the question whose answer should be changed. |
| `subform_index` | integer | No | Subform index number (starting from 1) if the question is inside a subform. Leave blank for questions not in subforms. |
| `question_value` | string | Yes | New value to set for the specified question. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create List

**Slug:** `DATASCOPE_CREATE_LIST`

Tool to create a new empty list (metadata type) in DataScope with specified list_type. Use when you need to create a container for list elements like products, locations, or other categorized items.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `list` | object | Yes | List data object containing all list details. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create List Element

**Slug:** `DATASCOPE_CREATE_LIST_ELEMENT`

Tool to create a new list element in a specific metadata list identified by metadata_type. Use when you need to add a new element to a list. For location objects, use the locations API instead.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `list_object` | object | Yes | List object containing element details |
| `metadata_type` | string | Yes | Internal code to identify the list (products, and more). For locations objects use locations API |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Location

**Slug:** `DATASCOPE_CREATE_LOCATION`

Tool to create a new location in DataScope with geographic coordinates. Use when you need to register a physical location with name and code identifiers.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `location` | object | Yes | Location data object containing all location details. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Task Assignment

**Slug:** `DATASCOPE_CREATE_TASK_ASSIGN`

Tool to create a task assignment for a specific form, user, and location with a deadline. Use when you need to assign a form to be completed by a specific user at a specific location and time.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `gap` | integer | No | Number of hours allocated to perform the task. |
| `code` | string | No | Custom code to identify or track the task. |
| `date` | string | Yes | Date and time of the assigned task in format YYYY-mm-dd HH:MM (e.g., '2026-02-20 10:00'). |
| `c_code` | string | No | Company tax identifier or code associated with the location. |
| `c_name` | string | No | Company name associated with the location. |
| `l_code` | string | Yes | Code identifier of the Location where the task should be performed. |
| `form_id` | integer | Yes | Internal identifier of the Form. ID in the URL https://www.mydatascope.com/task_forms/[ID]/edit |
| `l_email` | string | No | Email address of the Location. |
| `l_phone` | string | No | Phone number of the Location. |
| `user_id` | string | Yes | User Email to whom the task is assigned. |
| `latitude` | string | No | GPS latitude coordinate of the location. |
| `longitude` | string | No | GPS longitude coordinate of the location. |
| `location_name` | string | No | Name of the location. Only needed if you need to create or update the location. |
| `location_address` | string | No | Physical address of the Location. |
| `task_instruction` | string | No | Instructions or notes for completing the task. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get all list elements

**Slug:** `DATASCOPE_GET_ALL_LIST_ELEMENTS`

Tool to retrieve all items from a specific metadata list in Datascope. Use when you need to fetch all elements belonging to a particular list type (products, locations, customers, etc.).

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `metadata_type` | string | Yes | Internal code to identify the list (e.g., products, locations, etc.). This is required to specify which metadata list to retrieve. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get All Locations

**Slug:** `DATASCOPE_GET_ALL_LOCATIONS`

Tool to retrieve all locations configured in the DataScope system. Use when you need to access location data including addresses, coordinates, and company associations.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Answers V4

**Slug:** `DATASCOPE_GET_ANSWERS_V4`

Tool to retrieve form answers using the v4 API endpoint. Use when you need to fetch form submissions from DataScope with the latest API version. Supports filtering by user, date range, location, and pagination for retrieving large result sets.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `end` | string | No | End of date range for results in ISO 8601 format (e.g., '2024-12-31T23:59:59Z'). Default is today if not provided. |
| `limit` | integer | No | Number of submissions to return. Default is 200. Maximum allowed value is 200. |
| `start` | string | No | Beginning of date range for results in ISO 8601 format (e.g., '2024-01-01T00:00:00Z'). Default is last 7 days if not provided. |
| `offset` | integer | No | Pagination parameter for additional batches. Default is 0. Use this to retrieve subsequent pages of results. |
| `form_id` | integer | Yes | The ID of the form to retrieve answers for. This parameter is required. |
| `user_id` | integer | No | Filters results to responses from one specific user. If not provided, answers from all users are returned. |
| `location_id` | integer | No | Filters to answers from a specific location. If not provided, answers from all locations are returned. |
| `date_modified` | boolean | No | When true, returns only modified forms or new submissions. Default is false if not provided. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Answers With Full Metadata

**Slug:** `DATASCOPE_GET_ANSWERS_WITH_FULL_METADATA`

Tool to retrieve last form answers with full metadata from DataScope (limit 600 results). Returns detailed response structure including answers array with question types, metadata references, and assignment information. Use when you need comprehensive answer data with question-level details and metadata associations.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `end` | string | No | Set the end date range. Default is today if not provided. Use ISO 8601 format or date format. |
| `start` | string | No | Set the start date range. Default is last 7 days if not provided. Use ISO 8601 format or date format. |
| `form_id` | integer | No | If set, only get values of one form. When not provided, answers from all forms are returned. |
| `user_id` | string | No | If set, get values of only one user. This is a string identifier for the user. |
| `location_id` | integer | No | Set to get answers of only one location. When not provided, answers from all locations are returned. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Form Schema

**Slug:** `DATASCOPE_GET_FORM_SCHEMA`

Tool to retrieve the schema definition for a specific form by its form ID. Use when you need to understand the structure of a form including all questions, field types, and configurations.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `form_id` | string | Yes | Unique identifier of the form to retrieve the schema for. Can be found in Configure > Configure App section. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Forms List

**Slug:** `DATASCOPE_GET_FORMS_LIST`

Tool to retrieve all available forms/tasks from the DataScope system. Use when you need to get a list of forms that can be assigned or filled out.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Last Tickets

**Slug:** `DATASCOPE_GET_LAST_TICKETS`

Tool to retrieve the last 5 tickets (findings) from the DataScope system. Use when you need to view recent tickets or findings.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get List Element

**Slug:** `DATASCOPE_GET_LIST_ELEMENT`

Tool to retrieve a specific element from a metadata list by type and ID. Use when you need to fetch detailed information about a specific list element such as locations, products, or other metadata objects.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `metadata_id` | integer | Yes | Internal identifier of the element of the list |
| `metadata_type` | string | Yes | Internal code to identify the list (e.g., 'products', 'locations', etc.) |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Ticket Types

**Slug:** `DATASCOPE_GET_TICKET_TYPES`

Tool to retrieve available ticket types (findings types) from the DataScope system. Use when you need to access the list of ticket type configurations.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Last Generated Files

**Slug:** `DATASCOPE_LIST_LAST_GENERATED_FILES`

Tool to retrieve all generated files (PDFs, Excel) from a specific date range. Use when you need to access recently generated files within the last 90 days. Date format is MM/DD/YYYY.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `end` | string | No | Conclusion of the date range for file retrieval. Format: DD/MM/YYYY (e.g., '19/12/2019' for December 19, 2019). Defaults to today if not provided. Maximum date range is 90 days. |
| `start` | string | No | Beginning of the date range for file retrieval. Format: DD/MM/YYYY (e.g., '10/12/2019' for December 10, 2019). Defaults to last 7 days if not provided. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Notifications

**Slug:** `DATASCOPE_LIST_NOTIFICATIONS`

Tool to retrieve all notifications (PDF and Excel files) from a date range. Use when you need to access notification details including type, URL, form information, and timestamps.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `end` | string | No | Set the end date range. Format should match the API requirements. Defaults to today if not provided. |
| `start` | string | No | Set the start date range. Format should match the API requirements. Defaults to last 7 days if not provided. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Bulk update list elements

**Slug:** `DATASCOPE_UPDATE_BULK_LIST_ELEMENTS`

Tool to bulk update metadata list objects with soft deletion of objects not in the incoming list. Use when you need to replace all objects in a metadata list. WARNING: This operation deletes all existing objects for the specified metadata_type and replaces them with new objects. Experimental endpoint.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | Name of the list to be created or updated. |
| `list_objects` | array | Yes | Array of objects to be created or updated. WARNING: All existing objects for this metadata_type will be soft-deleted and replaced with these objects. Objects with existing codes will be updated; new codes will create new objects. |
| `metadata_type` | string | Yes | Internal code to identify the list to update. WARNING: Cannot be 'locations'. This identifies which metadata list to bulk update. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update List Element

**Slug:** `DATASCOPE_UPDATE_LIST_ELEMENT`

Tool to update an existing list element by ID with new name, description, code, or attributes. Use when you need to modify properties of a specific metadata object in DataScope.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | integer | Yes | The ID of the list element to update |
| `list_object` | object | Yes | List object containing updated element details |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Location

**Slug:** `DATASCOPE_UPDATE_LOCATION`

Tool to update an existing location in DataScope by ID. Use when you need to modify location details such as name, address, coordinates, or company information.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | integer | Yes | The ID of the location to update. |
| `location` | object | Yes | Location data object containing updated location details. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |