---
title: "Get Data Flow"
method: POST
path: "/data-security-flow/{id}/get-item"
tags: ["Data Flow"]
---

# Get Data Flow

`POST /data-security-flow/{id}/get-item`

## Request

- Base URL: `https://oneuptime.com/api`
- URL: `https://oneuptime.com/api/data-security-flow/{id}/get-item`
- Auth: API key in header `APIKey`
- TypeScript: <https://skmtc.dev/oneuptime/apis/oneuptime-openapi-specification/docs/data-security-flow/:id/get-item/post.ts> (a function with typed inputs; its response is checked against the schema)

Endpoint to retrieve a single Data Flow by ID

## Path parameters

- `id` string, uuid, required

## Request body

- object
  - `select` DataSecurityFlowSelectSchema: Select schema for DataSecurityFlow. Set fields to true to include them in the response.
    - `_id` boolean
    - `createdAt` boolean
    - `updatedAt` boolean
    - `deletedAt` boolean
    - `projectId` boolean
    - `flowKey` boolean
    - `kind` boolean
    - `sourceDataStoreId` boolean
    - `serviceId` boolean
    - `destinationDataStoreId` boolean
    - `destination` boolean
    - `dataTypeIds` boolean
    - `sensitivity` boolean
    - `isConfirmed` boolean
    - `overlapPercent` boolean
    - `callCount` boolean
    - `firstSeenAt` boolean
    - `lastSeenAt` boolean

## Response `200`

Successful response

- object
  - `data` DataSecurityFlow
    - `_id` string, uuid: ID of this object. Permissions - Create: [No access - you don't have permission for this operation], Read: [Project Owner, Project Admin, Security Admin, Security Member, Security Viewer, Read Data Flow], Update: [No access - you don't have permission for this operation]
    - `createdAt` object: Date and Time when the object was created. Permissions - Create: [No access - you don't have permission for this operation], Read: [Project Owner, Project Admin, Security Admin, Security Member, Security Viewer, Read Data Flow], Update: [No access - you don't have permission for this operation]
    - `updatedAt` object: Date and Time when the object was updated. Permissions - Create: [No access - you don't have permission for this operation], Read: [Project Owner, Project Admin, Security Admin, Security Member, Security Viewer, Read Data Flow], Update: [No access - you don't have permission for this operation]
    - `deletedAt` object: Date and Time when the object was deleted. Permissions - Create: [No access - you don't have permission for this operation], Read: [Project Owner, Project Admin, Security Admin, Security Member, Security Viewer, Read Data Flow], Update: [No access - you don't have permission for this operation]
    - `version` number: Object version
    - `projectId` string, uuid, required: ID of the project this data flow belongs to. Permissions - Create: [No access - you don't have permission for this operation], Read: [Project Owner, Project Admin, Security Admin, Security Member, Security Viewer, Read Data Flow], Update: [No access - you don't have permission for this operation]
    - `flowKey` string, required: The flow's kind, source and destination, which identify it within the project. Permissions - Create: [No access - you don't have permission for this operation], Read: [Project Owner, Project Admin, Security Admin, Security Member, Security Viewer, Read Data Flow], Update: [No access - you don't have permission for this operation]
    - `kind` string, required: What the flow is: Read, Write, AI Provider, External Host or Copy. Permissions - Create: [No access - you don't have permission for this operation], Read: [Project Owner, Project Admin, Security Admin, Security Member, Security Viewer, Read Data Flow], Update: [No access - you don't have permission for this operation]
    - `sourceDataStoreId` string, uuid: The store the data comes from. Permissions - Create: [No access - you don't have permission for this operation], Read: [Project Owner, Project Admin, Security Admin, Security Member, Security Viewer, Read Data Flow], Update: [No access - you don't have permission for this operation]
    - `serviceId` string, uuid: The service the data passes through. Permissions - Create: [No access - you don't have permission for this operation], Read: [Project Owner, Project Admin, Security Admin, Security Member, Security Viewer, Read Data Flow], Update: [No access - you don't have permission for this operation]
    - `destinationDataStoreId` string, uuid: The store the data reaches, for a write or a copy. Permissions - Create: [No access - you don't have permission for this operation], Read: [Project Owner, Project Admin, Security Admin, Security Member, Security Viewer, Read Data Flow], Update: [No access - you don't have permission for this operation]
    - `destination` string: Where the data goes, when it is not a store: a host or an AI provider. Permissions - Create: [No access - you don't have permission for this operation], Read: [Project Owner, Project Admin, Security Admin, Security Member, Security Viewer, Read Data Flow], Update: [No access - you don't have permission for this operation]
    - `dataTypeIds` object: The sensitive data types that can travel along the flow. Permissions - Create: [No access - you don't have permission for this operation], Read: [Project Owner, Project Admin, Security Admin, Security Member, Security Viewer, Read Data Flow], Update: [No access - you don't have permission for this operation]
    - `sensitivity` 'Restricted' | 'Confidential' | 'Internal' | 'Public', required: The sensitivity of the data that can travel along it. Permissions - Create: [No access - you don't have permission for this operation], Read: [Project Owner, Project Admin, Security Admin, Security Member, Security Viewer, Read Data Flow], Update: [No access - you don't have permission for this operation]
    - `isConfirmed` boolean, required: A scan found the data at the destination, not only the path to it. Permissions - Create: [No access - you don't have permission for this operation], Read: [Project Owner, Project Admin, Security Admin, Security Member, Security Viewer, Read Data Flow], Update: [No access - you don't have permission for this operation]
    - `overlapPercent` number, required: For a copy: how much of the source's values were found in the destination, from 0 to 100. Permissions - Create: [No access - you don't have permission for this operation], Read: [Project Owner, Project Admin, Security Admin, Security Member, Security Viewer, Read Data Flow], Update: [No access - you don't have permission for this operation]
    - `callCount` number, required: How many calls the service map counted along the flow in its last window. Permissions - Create: [No access - you don't have permission for this operation], Read: [Project Owner, Project Admin, Security Admin, Security Member, Security Viewer, Read Data Flow], Update: [No access - you don't have permission for this operation]
    - `firstSeenAt` object: When the flow was first seen. Permissions - Create: [No access - you don't have permission for this operation], Read: [Project Owner, Project Admin, Security Admin, Security Member, Security Viewer, Read Data Flow], Update: [No access - you don't have permission for this operation]
    - `lastSeenAt` object: When the flow was last seen. Permissions - Create: [No access - you don't have permission for this operation], Read: [Project Owner, Project Admin, Security Admin, Security Member, Security Viewer, Read Data Flow], Update: [No access - you don't have permission for this operation]

## Other responses

- `400`: Bad request. This response indicates that the request was malformed or contained invalid data.
- `401`: Unauthorized. This response indicates that the request requires user authentication.
- `402`: Payment Required. This response indicates that the request requires payment or a valid subscription.
- `403`: Forbidden. This response indicates that the server understood the request, but refuses to authorize it.
- `404`: Not found. The record does not exist, belongs to another project, or is one you may not read - the same answer for each.
- `405`: Project not found. This response indicates that the requested project does not exist or is not accessible.
- `408`: Request Timeout. This response indicates that the server timed out waiting for the request.
- `415`: Unable to reach server. This response indicates that the server is currently unreachable or down.
- `422`: Not authorized. This response indicates that the user does not have permission to access the requested resource.
- `500`: Internal Server Error. This response indicates that the server encountered an unexpected condition that prevented it from fulfilling the request.

---

[API](https://skmtc.dev/oneuptime/apis/oneuptime-openapi-specification.md) - [All operations](https://skmtc.dev/oneuptime/apis/oneuptime-openapi-specification/llms.txt) - [OpenAPI document](https://skmtc.dev/oneuptime/apis/oneuptime-openapi-specification/revisions/ba3307d00304?raw)
