Management API

Responses API

This set of API can be used to

List Responses
Get Response
Delete Response

You will need an API Key to interact with these APIs.

GET/api/v1/management/responses

List all Responses

Retrieve all the responses you have received in your environment.

Mandatory Headers

Name
x-Api-Key
Type
string
Description
Your TypeflowAI API key.

Request

GET

/api/v1/management/responses

curl --location \
'https://dashboard.typeflowai.com/api/v1/management/responses' \
--header \
'x-api-key: <your-api-key>'

Response

{
  "data":[
    {
        "id": "cln8k0tqv00pcz87no4qrw333",
        "createdAt": "2023-10-02T07:13:20.023Z",
        "updatedAt": "2023-10-02T07:13:20.023Z",
        "workflowId": "cln8k0tqu00p7z87nqr4thi3k",
        "finished": true,
        "data": {
            "interview-prompt": "clicked"
        },
        "meta": {
            "userAgent": {
                "os": "MacOS",
                "browser": "Chrome"
            }
        },
        "personAttributes": null,
        "person": {
            "id": "e0x4i5tvsp8puxfztyrwykvn",
            "attributes": {
                "userId": "CYO675",
                "email": "ravi@netflix.com",
                "Name": "Ravi Kumar",
                "Role": "Manager",
                "Company": "Netflix",
                "Experience": "6 years",
                "Usage Frequency": "Monthly",
                "Company Size": "4610 employees",
                "Product Satisfaction Score": "43",
                "Recommendation Likelihood": "4"
            },
            "environmentId": "cln8k0t47000fz87njmmu2bck",
            "createdAt": "2023-10-02T07:13:19.444Z",
            "updatedAt": "2023-10-02T07:13:19.444Z"
        },
        "notes": [],
        "tags": []
    },
  ]
}

GET/api/v1/management/responses/<response-id>

Get Response by ID

Retrieve a response by its ID.

Mandatory Headers

Name
x-Api-Key
Type
string
Description
Your TypeflowAI API key.

Request

GET

/api/v1/management/responses/<response-id>

curl --location \
'https://dashboard.typeflowai.com/api/v1/management/responses/<response-id>' \
--header \
'x-api-key: <your-api-key>'

Response

{
  "data":
  {
    "id": "cln8k0tqv00pbz87nwo5lr72b",
    "createdAt": "2023-10-02T07:13:20.023Z",
    "updatedAt": "2023-10-02T07:13:20.023Z",
    "workflowId": "cln8k0tqu00p7z87nqr4thi3k",
    "finished": true,
    "data": {
        "interview-prompt": "clicked"
    },
    "meta": {
        "userAgent": {
            "os": "Windows",
            "browser": "Edge"
        }
    },
    "personAttributes": null,
    "person": {
        "id": "hsx38f15v50ua8383uadagq5",
        "attributes": {
            "userId": "CYO278",
            "email": "jorge@facebook.com",
            "Name": "Jorge Sanchez",
            "Role": "Product Manager",
            "Company": "Facebook",
            "Experience": "10 years",
            "Usage Frequency": "Daily",
            "Company Size": "1685 employees",
            "Product Satisfaction Score": "84",
            "Recommendation Likelihood": "6"
        },
        "environmentId": "cln8k0t47000fz87njmmu2bck",
        "createdAt": "2023-10-02T07:13:19.444Z",
        "updatedAt": "2023-10-02T07:13:19.444Z"
    },
    "notes": [],
    "tags": []
  }
}

DELETE/api/v1/client/responses/<response-id>

Delete a response

Delete Response by ID

Mandatory Headers

Name
x-api-Key
Type
string
Description
Your TypeflowAI API key.

Request

DELETE

/api/v1/client/responses/<response-id>

curl -X DELETE https://dashboard.typeflowai.com/api/v1/management/responses/<response-id> \
 --header 'x-api-key: <your-api-key>'

Response

{
  "data": {
    "id": "cln8k0tqv00pbz87nwo5lr72b",
    "createdAt": "2023-10-02T07:13:20.023Z",
    "updatedAt": "2023-10-02T07:13:20.023Z",
    "workflowId": "cln8k0tqu00p7z87nqr4thi3k",
    "finished": true,
    "data": {
        "interview-prompt": "clicked"
    },
    "meta": {
        "userAgent": {
            "os": "Windows",
            "browser": "Edge"
        }
    },
    "personAttributes": null,
    "person": {
        "id": "hsx38f15v50ua8383uadagq5",
        "attributes": {
            "userId": "CYO278",
            "email": "jorge@facebook.com",
            "Name": "Jorge Sanchez",
            "Role": "Product Manager",
            "Company": "Facebook",
            "Experience": "10 years",
            "Usage Frequency": "Daily",
            "Company Size": "1685 employees",
            "Product Satisfaction Score": "84",
            "Recommendation Likelihood": "6"
        },
        "environmentId": "cln8k0t47000fz87njmmu2bck",
        "createdAt": "2023-10-02T07:13:19.444Z",
        "updatedAt": "2023-10-02T07:13:19.444Z"
    },
    "notes": [],
    "tags": []
  }
}