User

Get the current user's information

get

Responses

200

Successfully retrieved user information.

application/json

get

/user

HTTPcURLJavaScriptPython

GET /user HTTP/1.1
Host: api.taag.co
Accept: */*

200

Successfully retrieved user information.

{
  "status": "success",
  "user": {
    "id": 20128,
    "company_id": 385,
    "name": "Phillip Musiime",
    "email": "[email protected]",
    "email_verified": 1,
    "email_code": "210000199602133397",
    "password": "5baa61e4c9b93f3f0682250b6cf8331b7ee68fd8",
    "2fa": 0,
    "rp_code": "44000020150502575X",
    "rp_timestamp": 1702495813,
    "language": "en",
    "lead_sync": 1,
    "enterprise": 0,
    "email_timestamp": null,
    "plan": "NULL",
    "priceId": "NULL",
    "customerId": "NULL",
    "subscriptionId": "NULL",
    "third_party": "NULL",
    "third_party_uid": "NULL",
    "timestamp": 1702495813,
    "profiles_public": 0,
    "start_onboarding": 0,
    "send_followup_lead_email": 0,
    "send_followup_lead_email_in_days": 0,
    "image": "https://picsum.photos/200"
  }
}

Create a new user

post

Body

application/json

namestringRequired

The name of the user

emailstring · emailRequired

The email address of the user

passwordstring · passwordRequired

The password for the user

originstringOptional

The origin of the request, e.g., 'mobile' or 'web'

app_versionstringOptional

The version of the application

company_invite_codestringOptional

The company invite code if the user is joining a company

Responses

200

Successfully created a new user.

application/json

post

/user

HTTPcURLJavaScriptPython

POST /user HTTP/1.1
Host: api.taag.co
Content-Type: application/json
Accept: */*
Content-Length: 128

{
  "name": "text",
  "email": "[email protected]",
  "password": "password",
  "origin": "text",
  "app_version": "text",
  "company_invite_code": "text"
}

200

Successfully created a new user.

{
  "status": "success",
  "session_token": "text",
  "user": {
    "id": 20128,
    "company_id": 385,
    "name": "Phillip Musiime",
    "email": "[email protected]",
    "email_verified": 1,
    "email_code": "210000199602133397",
    "password": "5baa61e4c9b93f3f0682250b6cf8331b7ee68fd8",
    "2fa": 0,
    "rp_code": "44000020150502575X",
    "rp_timestamp": 1702495813,
    "language": "en",
    "lead_sync": 1,
    "enterprise": 0,
    "email_timestamp": null,
    "plan": "NULL",
    "priceId": "NULL",
    "customerId": "NULL",
    "subscriptionId": "NULL",
    "third_party": "NULL",
    "third_party_uid": "NULL",
    "timestamp": 1702495813,
    "profiles_public": 0,
    "start_onboarding": 0,
    "send_followup_lead_email": 0,
    "send_followup_lead_email_in_days": 0,
    "image": "https://picsum.photos/200"
  }
}

Update User Information

put

Body

application/json

fieldstringRequired

The field to update

Example: email

valuestringRequired

The new value for the field

Example: [email protected]

user_idintegerOptional

The ID of the user to update, defaults to the current session user

Example: 20128

Responses

200

Successfully updated user information.

application/json

put

/user

HTTPcURLJavaScriptPython

PUT /user HTTP/1.1
Host: api.taag.co
Content-Type: application/json
Accept: */*
Content-Length: 65

{
  "field": "email",
  "value": "[email protected]",
  "user_id": 20128
}

200

Successfully updated user information.

{
  "status": "success",
  "user": {
    "id": 20128,
    "company_id": 385,
    "name": "Phillip Musiime",
    "email": "[email protected]",
    "email_verified": 1,
    "email_code": "210000199602133397",
    "password": "5baa61e4c9b93f3f0682250b6cf8331b7ee68fd8",
    "2fa": 0,
    "rp_code": "44000020150502575X",
    "rp_timestamp": 1702495813,
    "language": "en",
    "lead_sync": 1,
    "enterprise": 0,
    "email_timestamp": null,
    "plan": "NULL",
    "priceId": "NULL",
    "customerId": "NULL",
    "subscriptionId": "NULL",
    "third_party": "NULL",
    "third_party_uid": "NULL",
    "timestamp": 1702495813,
    "profiles_public": 0,
    "start_onboarding": 0,
    "send_followup_lead_email": 0,
    "send_followup_lead_email_in_days": 0,
    "image": "https://picsum.photos/200"
  }
}

Delete User

delete

Responses

200

Successfully deleted user.

application/json

delete

/user

HTTPcURLJavaScriptPython

DELETE /user HTTP/1.1
Host: api.taag.co
Accept: */*

200

Successfully deleted user.

{
  "status": "success"
}

Offboard Users

post

Body

multipart/form-data

company_idintegerRequired

The ID of the company

Example: 385

filestring · binaryRequired

The CSV file containing the emails of users to offboard

Responses

200

Successfully offboarded users.

application/json

post

/users/offboard

HTTPcURLJavaScriptPython

POST /users/offboard HTTP/1.1
Host: api.taag.co
Content-Type: multipart/form-data
Accept: */*
Content-Length: 34

{
  "company_id": 385,
  "file": "binary"
}

200

Successfully offboarded users.

{
  "status": "success"
}

Get IP Data

get

Responses

200

Successfully retrieved IP data.

application/json

get

/user/ipdata

HTTPcURLJavaScriptPython

GET /user/ipdata HTTP/1.1
Host: api.taag.co
Accept: */*

200

Successfully retrieved IP data.

{
  "status": "success",
  "data": {
    "query": "text",
    "status": "text",
    "country": "text",
    "countryCode": "text",
    "region": "text",
    "regionName": "text",
    "city": "text",
    "zip": "text",
    "lat": 1,
    "lon": 1,
    "timezone": "text",
    "isp": "text",
    "org": "text",
    "as": "text"
  }
}