Management API

People API

This set of API can be used to

List People
Get Person
Delete Person

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

GET/api/v1/management/people

List People

Mandatory Headers

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

Request

GET

/api/v1/management/people

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

Response

{
  "data": [
      {
        "id": "b4wgrzl363dn3zb6yy5gf265",
        "attributes": {
            "userId": "CYO618",
            "email": "sophia@amazon.com",
            "Name": "Sophia Johnson",
            "Role": "Designer",
            "Company": "Amazon",
            "Experience": "7 years",
            "Usage Frequency": "Yearly",
            "Company Size": "1628 employees",
            "Product Satisfaction Score": "62",
            "Recommendation Likelihood": "9"
        },
        "environmentId": "cln8k0t47000fz87njmmu2bck",
        "createdAt": "2023-10-02T07:13:19.444Z",
        "updatedAt": "2023-10-02T07:13:19.444Z"
      },
      {
        "id": "jrb5iyzqvnkg9322ckhde3j4",
        "attributes": {
            "userId": "CYO511",
            "email": "antonio@ibm.com",
            "Name": "Antonio García",
            "Role": "Designer",
            "Company": "IBM",
            "Experience": "1 years",
            "Usage Frequency": "Weekly",
            "Company Size": "4023 employees",
            "Product Satisfaction Score": "77",
            "Recommendation Likelihood": "4"
        },
        "environmentId": "cln8k0t47000fz87njmmu2bck",
        "createdAt": "2023-10-02T07:13:19.444Z",
        "updatedAt": "2023-10-02T07:13:19.444Z"
      },
  ]
}

GET/api/v1/management/people/<person-id>

Get Person

Get Person by ID

Mandatory Headers

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

Request

GET

/api/v1/management/people/<person-id>

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

Response

{
  "data": {
    "id": "jrb5iyzqvnkg9322ckhde3j4",
    "attributes": {
        "userId": "CYO511",
        "email": "antonio@ibm.com",
        "Name": "Antonio García",
        "Role": "Designer",
        "Company": "IBM",
        "Experience": "1 years",
        "Usage Frequency": "Weekly",
        "Company Size": "4023 employees",
        "Product Satisfaction Score": "77",
        "Recommendation Likelihood": "4"
    },
    "environmentId": "cln8k0t47000fz87njmmu2bck",
    "createdAt": "2023-10-02T07:13:19.444Z",
    "updatedAt": "2023-10-02T07:13:19.444Z"
  }
}

DELETE/api/v1/management/people/<person-id>

Delete Person

Delete Person by ID

Mandatory Headers

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

Request

DELETE

/api/v1/management/people/<person-id>

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

Response

{
  "data": {
    "success": "Person deleted successfully"
  }
}