Company Groups

Create a new group

post

Creates a new group under a specified company.

Body

company_idintegerRequired

The ID of the company to create the group in.

Example: 385

parent_group_idintegerOptional

The ID of the parent group under which this group will be created.

Example: 1

namestringRequired

The name of the group.

Example: Sales Team

descriptionstringOptional

A brief description of the group.

Example: This group handles all sales operations.

Responses

200

Group created successfully

application/json

post

/company/group

POST /company/group HTTP/1.1
Host: api.taag.co
Content-Type: application/json
Accept: */*
Content-Length: 115

{
  "company_id": 385,
  "parent_group_id": 1,
  "name": "Sales Team",
  "description": "This group handles all sales operations."
}

200

Group created successfully

{
  "status": "success",
  "group": {
    "id": 257,
    "company_id": 385,
    "parent_group_id": null,
    "azure_group_id": "ccaf0e51-7a3b-48b0-8c0a-81bded3fe1fe",
    "name": "AAD-3ADS-AS-CFG-APP-MyTaag",
    "description": null,
    "image": null,
    "timestamp": 1723636850,
    "image_company": null,
    "image_banner": null,
    "background": null,
    "text": null,
    "icons": null,
    "font": null,
    "order": null,
    "automation_mappings": "{\"department\":\"test name\"}",
    "language": null,
    "hide_default_profile_data_from_company": null,
    "members": [
      "23083",
      "23084",
      "23085",
      "23086",
      "23087",
      "23088",
      "23089",
      "23090",
      "23091"
    ],
    "default_profile_data": [
      {
        "id": 12345,
        "profile_id": 67890,
        "key": "job_title",
        "value": "Software Engineer",
        "type": "profile",
        "title": "Job Title",
        "description": "The role or title in the company",
        "highlight": 0,
        "active": 1,
        "order": 1,
        "icon_url": "https://example.com/icon.png",
        "group_id": 54321,
        "company_id": 385
      }
    ]
  }
}

Get group details

get

Fetches details of a specific group by its ID.

Body

group_idintegerRequired

The ID of the group to retrieve.

Example: 257

Responses

200

Group retrieved successfully

application/json

get

/company/group

GET /company/group HTTP/1.1
Host: api.taag.co
Content-Type: application/json
Accept: */*
Content-Length: 16

{
  "group_id": 257
}

200

Group retrieved successfully

{
  "status": "success",
  "group": {
    "id": 257,
    "company_id": 385,
    "parent_group_id": null,
    "azure_group_id": "ccaf0e51-7a3b-48b0-8c0a-81bded3fe1fe",
    "name": "AAD-3ADS-AS-CFG-APP-MyTaag",
    "description": null,
    "image": null,
    "timestamp": 1723636850,
    "image_company": null,
    "image_banner": null,
    "background": null,
    "text": null,
    "icons": null,
    "font": null,
    "order": null,
    "automation_mappings": "{\"department\":\"test name\"}",
    "language": null,
    "hide_default_profile_data_from_company": null,
    "members": [
      "23083",
      "23084",
      "23085",
      "23086",
      "23087",
      "23088",
      "23089",
      "23090",
      "23091"
    ],
    "default_profile_data": [
      {
        "id": 12345,
        "profile_id": 67890,
        "key": "job_title",
        "value": "Software Engineer",
        "type": "profile",
        "title": "Job Title",
        "description": "The role or title in the company",
        "highlight": 0,
        "active": 1,
        "order": 1,
        "icon_url": "https://example.com/icon.png",
        "group_id": 54321,
        "company_id": 385
      }
    ]
  }
}

Update group details

put

Updates the details of an existing group based on the provided fields.

Body

group_idintegerRequired

The ID of the group to update.

Example: 257

languagestringOptional

Language setting for the group.

Example: en

fontstringOptional

Font used in the group.

Example: Arial

image_bannerstringOptional

URL or path to the banner image.

Example: https://example.com/banner.png

image_companystringOptional

URL or path to the company image.

Example: https://example.com/company.png

imagestringOptional

URL or path to the group image.

Example: https://example.com/group.png

descriptionstringOptional

A brief description of the group.

Example: This is a description of the group.

namestringOptional

The name of the group.

Example: Sales Team

parent_group_idintegerOptional

The ID of the parent group.

Example: 1

company_idintegerOptional

The ID of the company associated with the group.

Example: 385

hide_default_profile_data_from_companyinteger · enumOptional

Flag to hide default profile data from the company.

Possible values:

iconsstringOptional

Hex code for icon color.

Example: FFFFFF

textstringOptional

Hex code for text color.

Example: 000000

backgroundstringOptional

Hex code for background color.

Example: 333333

automation_mappingsobjectOptional

Automation mappings for the group.

Example: {"department":"Sales","job":"Manager"}

Responses

200

Group update success response

application/json

put

/company/group

PUT /company/group HTTP/1.1
Host: api.taag.co
Content-Type: application/json
Accept: */*
Content-Length: 453

{
  "group_id": 257,
  "language": "en",
  "font": "Arial",
  "image_banner": "https://example.com/banner.png",
  "image_company": "https://example.com/company.png",
  "image": "https://example.com/group.png",
  "description": "This is a description of the group.",
  "name": "Sales Team",
  "parent_group_id": 1,
  "company_id": 385,
  "hide_default_profile_data_from_company": 0,
  "icons": "FFFFFF",
  "text": "000000",
  "background": "333333",
  "automation_mappings": {
    "department": "Sales",
    "job": "Manager"
  }
}

200

Group update success response

{
  "status": "success",
  "group": {
    "id": 257,
    "company_id": 385,
    "parent_group_id": null,
    "azure_group_id": "ccaf0e51-7a3b-48b0-8c0a-81bded3fe1fe",
    "name": "AAD-3ADS-AS-CFG-APP-MyTaag",
    "description": null,
    "image": null,
    "timestamp": 1723636850,
    "image_company": null,
    "image_banner": null,
    "background": null,
    "text": null,
    "icons": null,
    "font": null,
    "order": null,
    "automation_mappings": "{\"department\":\"test name\"}",
    "language": null,
    "hide_default_profile_data_from_company": null,
    "members": [
      "23083",
      "23084",
      "23085",
      "23086",
      "23087",
      "23088",
      "23089",
      "23090",
      "23091"
    ],
    "default_profile_data": [
      {
        "id": 12345,
        "profile_id": 67890,
        "key": "job_title",
        "value": "Software Engineer",
        "type": "profile",
        "title": "Job Title",
        "description": "The role or title in the company",
        "highlight": 0,
        "active": 1,
        "order": 1,
        "icon_url": "https://example.com/icon.png",
        "group_id": 54321,
        "company_id": 385
      }
    ]
  }
}

Get all groups

get

Retrieves all groups under a specified company, including their top profiles.

Body

company_idintegerRequired

The ID of the company to retrieve groups for.

Example: 385

Responses

200

Groups retrieved successfully

application/json

get

/company/groups

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

{
  "company_id": 385
}

200

Groups retrieved successfully

{
  "status": "success",
  "groups": [
    {
      "id": 257,
      "company_id": 385,
      "parent_group_id": null,
      "azure_group_id": "ccaf0e51-7a3b-48b0-8c0a-81bded3fe1fe",
      "name": "AAD-3ADS-AS-CFG-APP-MyTaag",
      "description": null,
      "image": null,
      "timestamp": 1723636850,
      "image_company": null,
      "image_banner": null,
      "background": null,
      "text": null,
      "icons": null,
      "font": null,
      "order": null,
      "automation_mappings": "{\"department\":\"test name\"}",
      "language": null,
      "hide_default_profile_data_from_company": null,
      "members": [
        "23083",
        "23084",
        "23085",
        "23086",
        "23087",
        "23088",
        "23089",
        "23090",
        "23091"
      ],
      "default_profile_data": [
        {
          "id": 12345,
          "profile_id": 67890,
          "key": "job_title",
          "value": "Software Engineer",
          "type": "profile",
          "title": "Job Title",
          "description": "The role or title in the company",
          "highlight": 0,
          "active": 1,
          "order": 1,
          "icon_url": "https://example.com/icon.png",
          "group_id": 54321,
          "company_id": 385
        }
      ]
    }
  ]
}

Search groups

get

Searches for groups within a company based on a query string.

Body

company_idintegerRequired

The ID of the company to search groups within.

Example: 385

querystringRequired

The query string to search for groups.

Example: Sales

Responses

200

Groups search results

application/json

get

/company/groups/search

GET /company/groups/search HTTP/1.1
Host: api.taag.co
Content-Type: application/json
Accept: */*
Content-Length: 34

{
  "company_id": 385,
  "query": "Sales"
}

200

Groups search results

{
  "status": "success",
  "groups": [
    {
      "id": 257,
      "company_id": 385,
      "parent_group_id": null,
      "azure_group_id": "ccaf0e51-7a3b-48b0-8c0a-81bded3fe1fe",
      "name": "AAD-3ADS-AS-CFG-APP-MyTaag",
      "description": null,
      "image": null,
      "timestamp": 1723636850,
      "image_company": null,
      "image_banner": null,
      "background": null,
      "text": null,
      "icons": null,
      "font": null,
      "order": null,
      "automation_mappings": "{\"department\":\"test name\"}",
      "language": null,
      "hide_default_profile_data_from_company": null,
      "members": [
        "23083",
        "23084",
        "23085",
        "23086",
        "23087",
        "23088",
        "23089",
        "23090",
        "23091"
      ],
      "default_profile_data": [
        {
          "id": 12345,
          "profile_id": 67890,
          "key": "job_title",
          "value": "Software Engineer",
          "type": "profile",
          "title": "Job Title",
          "description": "The role or title in the company",
          "highlight": 0,
          "active": 1,
          "order": 1,
          "icon_url": "https://example.com/icon.png",
          "group_id": 54321,
          "company_id": 385
        }
      ]
    }
  ]
}

Update the order of company groups

put

Updates the order of the groups for a company.

Body

company_idintegerRequired

The ID of the company.

Example: 385

orderinteger[]Required

An array representing the new order of group IDs.

Example: 257

Responses

200

Order update success response

application/json

put

/company/groups/order

PUT /company/groups/order HTTP/1.1
Host: api.taag.co
Content-Type: application/json
Accept: */*
Content-Length: 32

{
  "company_id": 385,
  "order": [
    257
  ]
}

200

Order update success response

{
  "status": "success",
  "company": {
    "id": 12345,
    "user_id": 67890,
    "path": "example-company",
    "name": "Example Company",
    "description": "This is an example company description.",
    "image_profile": "https://some-domain/images/profile.png",
    "image_banner": "https://some-domain/images/banner.png",
    "background": "#ffffff",
    "icons": "#000000",
    "text": "#333333",
    "font": "https://some-domain/fonts/some-font.ttf",
    "lead_form_setting": 1,
    "lead_form_custom": 0,
    "disable_lead_form": 0,
    "instant_lead_form_on": 0,
    "plan_required": 1,
    "plan": "pro",
    "priceId": "price_1JwXzj2eZvKYlo2CmVxKJZJz",
    "customerId": "cus_Jxshb82JSHa2pB",
    "subscriptionId": "sub_Jxs92hjg9KSAoQ",
    "pay_via_invoice": 0,
    "pay_via_invoice_ppu": 0.01,
    "pay_via_invoice_payday": 1,
    "verified": 0,
    "timestamp": 1624857600,
    "lead_data_consent_email_text": "Please provide consent to receive emails.",
    "lead_data_consent_required": 0,
    "language": "en",
    "uneditable_profile_fields": [
      "email",
      "username"
    ],
    "user_email_unchangeable": 1,
    "lead_opt_out_available": 0,
    "profiles_public": 0,
    "force_sso": 0,
    "signup_options": [
      "email_password"
    ],
    "lock_profiles": 0,
    "custom_url": "https://customurl.com",
    "lead_create_reminder_days": 15,
    "lead_create_reminder_type": "email",
    "send_followup_lead_email": 0,
    "send_followup_lead_email_in_days": 7,
    "only_show_own_lead": 0
  }
}

PreviousCompany Data NextCompany Group Members

Last updated 1 year ago