Company Users

Retrieve users associated with a company

get

Fetches a list of users associated with the specified company. Supports pagination and optional retrieval of only user IDs.

Query parameters

company_idintegerRequired

The ID of the company for which to retrieve users.

Example: 98765

limitintegerOptional

The number of users to retrieve per page.

Example: 10

pageintegerOptional

The page number to retrieve.

Example: 1

only_idsbooleanOptional

Flag to indicate if only user IDs should be returned.

Example: false

Responses

200

A list of users or user IDs associated with the company.

application/json

Responseone of

or

integer[]Optional

get

/company/users

HTTPcURLJavaScriptPython

GET /company/users?company_id=98765 HTTP/1.1
Host: api.taag.co
Accept: */*

200

A list of users or user IDs associated with the company.

[
  {
    "id": 20858,
    "company_id": 385,
    "name": "Rodger Barton IV",
    "email": "[email protected]",
    "email_verified": 1,
    "email_code": "c9a7a662ac91793c7785835b759e4641",
    "password": "5baa61e4c9b93f3f0682250b6cf8331b7ee68fd8",
    "2fa": 1,
    "rp_code": "0ce923bf1b38af6d08fa931657e9e0f8",
    "rp_timestamp": 1702554908,
    "language": "en",
    "lead_sync": 0,
    "enterprise": 0,
    "email_timestamp": 1702554908,
    "plan": "pro",
    "priceId": "price_1JwXzj2eZvKYlo2CmVxKJZJz",
    "customerId": "cus_Jxshb82JSHa2pB",
    "subscriptionId": "sub_Jxs92hjg9KSAoQ",
    "third_party": "google",
    "third_party_uid": "adsfadu09a96a87d6fad6f0ad",
    "timestamp": 1702554908,
    "profiles_public": 0,
    "start_onboarding": 0,
    "send_followup_lead_email": 0,
    "send_followup_lead_email_in_days": 7,
    "roles": [
      "roles"
    ],
    "roles_count": 11,
    "invitation_status": "",
    "image": "https://picsum.photos/200"
  }
]

Search users within a company

get

Searches for users in a company based on a query string. Supports limiting the number of results returned.

Query parameters

company_idintegerRequired

The ID of the company in which to search for users.

Example: 385

querystringRequired

The search query to use for finding users.

Example: John

limitintegerOptional

The maximum number of users to return.

Example: 10

Responses

200

A successful response with the list of users matching the search query.

application/json

get

/company/users/search

HTTPcURLJavaScriptPython

GET /company/users/search?company_id=385&query=John HTTP/1.1
Host: api.taag.co
Accept: */*

200

A successful response with the list of users matching the search query.

{
  "status": "success",
  "users": [
    {
      "id": 20858,
      "company_id": 385,
      "name": "Rodger Barton IV",
      "email": "[email protected]",
      "email_verified": 1,
      "email_code": "c9a7a662ac91793c7785835b759e4641",
      "password": "5baa61e4c9b93f3f0682250b6cf8331b7ee68fd8",
      "2fa": 1,
      "rp_code": "0ce923bf1b38af6d08fa931657e9e0f8",
      "rp_timestamp": 1702554908,
      "language": "en",
      "lead_sync": 0,
      "enterprise": 0,
      "email_timestamp": 1702554908,
      "plan": "pro",
      "priceId": "price_1JwXzj2eZvKYlo2CmVxKJZJz",
      "customerId": "cus_Jxshb82JSHa2pB",
      "subscriptionId": "sub_Jxs92hjg9KSAoQ",
      "third_party": "google",
      "third_party_uid": "adsfadu09a96a87d6fad6f0ad",
      "timestamp": 1702554908,
      "profiles_public": 0,
      "start_onboarding": 0,
      "send_followup_lead_email": 0,
      "send_followup_lead_email_in_days": 7,
      "roles": [
        "roles"
      ],
      "roles_count": 11,
      "invitation_status": "",
      "image": "https://picsum.photos/200"
    }
  ]
}

Get Users and Roles

get

Retrieves a list of users and their associated roles for a specified company.

Body

application/json

company_idintegerRequired

The ID of the company to retrieve users and roles for.

Example: 385

Responses

200

List of users and their roles

application/json

get

/company/users/roles

HTTPcURLJavaScriptPython

GET /company/users/roles HTTP/1.1
Host: api.taag.co
Content-Type: application/json
Accept: */*
Content-Length: 18

{
  "company_id": 385
}

200

List of users and their roles

{
  "status": "success",
  "users": [
    {
      "id": 20858,
      "company_id": 385,
      "name": "Rodger Barton IV",
      "email": "[email protected]",
      "email_verified": 1,
      "email_code": "c9a7a662ac91793c7785835b759e4641",
      "password": "5baa61e4c9b93f3f0682250b6cf8331b7ee68fd8",
      "2fa": 1,
      "rp_code": "0ce923bf1b38af6d08fa931657e9e0f8",
      "rp_timestamp": 1702554908,
      "language": "en",
      "lead_sync": 0,
      "enterprise": 0,
      "email_timestamp": 1702554908,
      "plan": "pro",
      "priceId": "price_1JwXzj2eZvKYlo2CmVxKJZJz",
      "customerId": "cus_Jxshb82JSHa2pB",
      "subscriptionId": "sub_Jxs92hjg9KSAoQ",
      "third_party": "google",
      "third_party_uid": "adsfadu09a96a87d6fad6f0ad",
      "timestamp": 1702554908,
      "profiles_public": 0,
      "start_onboarding": 0,
      "send_followup_lead_email": 0,
      "send_followup_lead_email_in_days": 7,
      "roles": [
        "roles"
      ],
      "roles_count": 11,
      "invitation_status": "",
      "image": "https://picsum.photos/200"
    }
  ]
}

Update User Roles

put

Updates the roles for a specific user within a company. If the user does not exist, they will be created and invited.

Body

application/json

company_idintegerRequired

The ID of the company.

Example: 385

user_idintegerOptional

The ID of the user. Required if user_email is not provided.

Example: 12345

user_emailstringOptional

The email of the user. Required if user_id is not provided.

Example: [email protected]

rolesstring[]Required

Array of roles to assign to the user.

Example: admin

Responses

200

Updated list of users and their roles

application/json

put

/company/users/roles

HTTPcURLJavaScriptPython

PUT /company/users/roles HTTP/1.1
Host: api.taag.co
Content-Type: application/json
Accept: */*
Content-Length: 84

{
  "company_id": 385,
  "user_id": 12345,
  "user_email": "[email protected]",
  "roles": [
    "admin"
  ]
}

200

Updated list of users and their roles

{
  "status": "success",
  "users": [
    {
      "id": 20858,
      "company_id": 385,
      "name": "Rodger Barton IV",
      "email": "[email protected]",
      "email_verified": 1,
      "email_code": "c9a7a662ac91793c7785835b759e4641",
      "password": "5baa61e4c9b93f3f0682250b6cf8331b7ee68fd8",
      "2fa": 1,
      "rp_code": "0ce923bf1b38af6d08fa931657e9e0f8",
      "rp_timestamp": 1702554908,
      "language": "en",
      "lead_sync": 0,
      "enterprise": 0,
      "email_timestamp": 1702554908,
      "plan": "pro",
      "priceId": "price_1JwXzj2eZvKYlo2CmVxKJZJz",
      "customerId": "cus_Jxshb82JSHa2pB",
      "subscriptionId": "sub_Jxs92hjg9KSAoQ",
      "third_party": "google",
      "third_party_uid": "adsfadu09a96a87d6fad6f0ad",
      "timestamp": 1702554908,
      "profiles_public": 0,
      "start_onboarding": 0,
      "send_followup_lead_email": 0,
      "send_followup_lead_email_in_days": 7,
      "roles": [
        "roles"
      ],
      "roles_count": 11,
      "invitation_status": "",
      "image": "https://picsum.photos/200"
    }
  ]
}

Delete User Roles

delete

Removes all roles from a specified user within a company.

Body

application/json

company_idintegerRequired

The ID of the company.

Example: 385

user_idintegerRequired

The ID of the user.

Example: 12345

Responses

200

Updated list of users and their roles

application/json

delete

/company/users/roles

HTTPcURLJavaScriptPython

DELETE /company/users/roles HTTP/1.1
Host: api.taag.co
Content-Type: application/json
Accept: */*
Content-Length: 34

{
  "company_id": 385,
  "user_id": 12345
}

200

Updated list of users and their roles

{
  "status": "success",
  "users": [
    {
      "id": 20858,
      "company_id": 385,
      "name": "Rodger Barton IV",
      "email": "[email protected]",
      "email_verified": 1,
      "email_code": "c9a7a662ac91793c7785835b759e4641",
      "password": "5baa61e4c9b93f3f0682250b6cf8331b7ee68fd8",
      "2fa": 1,
      "rp_code": "0ce923bf1b38af6d08fa931657e9e0f8",
      "rp_timestamp": 1702554908,
      "language": "en",
      "lead_sync": 0,
      "enterprise": 0,
      "email_timestamp": 1702554908,
      "plan": "pro",
      "priceId": "price_1JwXzj2eZvKYlo2CmVxKJZJz",
      "customerId": "cus_Jxshb82JSHa2pB",
      "subscriptionId": "sub_Jxs92hjg9KSAoQ",
      "third_party": "google",
      "third_party_uid": "adsfadu09a96a87d6fad6f0ad",
      "timestamp": 1702554908,
      "profiles_public": 0,
      "start_onboarding": 0,
      "send_followup_lead_email": 0,
      "send_followup_lead_email_in_days": 7,
      "roles": [
        "roles"
      ],
      "roles_count": 11,
      "invitation_status": "",
      "image": "https://picsum.photos/200"
    }
  ]
}