Company Group Members

Get group members

get

Retrieves the profiles of members belonging to a specific group.

Body

application/json

group_idintegerRequired

The ID of the group to retrieve members for.

Example: 257

limitintegerRequired

The maximum number of profiles to retrieve.

Example: 10

pageintegerRequired

The page number to retrieve.

Example: 1

Responses

200

Group members retrieved successfully

application/json

get

/company/group/members

HTTPcURLJavaScriptPython

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

{
  "group_id": 257,
  "limit": 10,
  "page": 1
}

200

Group members retrieved successfully

{
  "status": "success",
  "profiles": [
    {
      "id": 22300,
      "user_id": 21312,
      "company_id": 385,
      "path": "path320125",
      "name": "Allene Larson",
      "job": "Dancer",
      "company": "Zulauf-Emmerich",
      "description": "Incidunt placeat dolorem in aut ut est harum praesentium.",
      "image_profile": "https://picsum.photos/200",
      "image_company": "https://picsum.photos/200",
      "image_banner": "https://picsum.photos/600/300",
      "background": "#12582c",
      "text": "",
      "icons": "",
      "font": "",
      "lead_form_setting": 1,
      "lead_form_custom": 0,
      "disable_lead_form": 0,
      "instant_lead_form_on": 1,
      "locked": 1,
      "created_by": "azure",
      "verified": 0,
      "timestamp": 1702555178,
      "language": null,
      "active": 1,
      "primary": 1,
      "department": null,
      "user_email": "[email protected]"
    }
  ]
}

Add members to a group

post

Adds one or more profiles to a specified group.

Body

application/json

group_idintegerRequired

The ID of the group to which profiles will be added.

Example: 257

profile_idsinteger[]Required

An array of profile IDs to add to the group.

Example: 21922

company_idintegerOptional

The ID of the company associated with the group.

Example: 385

Responses

200

Member addition success response

application/json

post

/company/group/members

HTTPcURLJavaScriptPython

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

{
  "group_id": 257,
  "profile_ids": [
    21922
  ],
  "company_id": 385
}

200

Member addition success response

{
  "status": "success"
}

Remove members from a group

delete

Removes one or more profiles from a specified group.

Body

application/json

group_idintegerRequired

The ID of the group from which profiles will be removed.

Example: 257

profile_idsinteger[]Required

An array of profile IDs to remove from the group.

Example: 21922

Responses

200

Member removal success response

application/json

delete

/company/group/members

HTTPcURLJavaScriptPython

DELETE /company/group/members HTTP/1.1
Host: api.taag.co
Content-Type: application/json
Accept: */*
Content-Length: 38

{
  "group_id": 257,
  "profile_ids": [
    21922
  ]
}

200

Member removal success response

{
  "status": "success"
}

Search group members

get

Searches for members within a specific group based on a query string.

Body

application/json

group_idintegerRequired

The ID of the group to search members within.

Example: 257

querystringRequired

The query string to search for members.

Example: John

company_idintegerRequired

The ID of the company associated with the group.

Example: 385

Responses

200

Group members search results

application/json

get

/company/group/members/search

HTTPcURLJavaScriptPython

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

{
  "group_id": 257,
  "query": "John",
  "company_id": 385
}

200

Group members search results

{
  "status": "success",
  "profiles": [
    {
      "id": 22300,
      "user_id": 21312,
      "company_id": 385,
      "path": "path320125",
      "name": "Allene Larson",
      "job": "Dancer",
      "company": "Zulauf-Emmerich",
      "description": "Incidunt placeat dolorem in aut ut est harum praesentium.",
      "image_profile": "https://picsum.photos/200",
      "image_company": "https://picsum.photos/200",
      "image_banner": "https://picsum.photos/600/300",
      "background": "#12582c",
      "text": "",
      "icons": "",
      "font": "",
      "lead_form_setting": 1,
      "lead_form_custom": 0,
      "disable_lead_form": 0,
      "instant_lead_form_on": 1,
      "locked": 1,
      "created_by": "azure",
      "verified": 0,
      "timestamp": 1702555178,
      "language": null,
      "active": 1,
      "primary": 1,
      "department": null,
      "user_email": "[email protected]"
    }
  ]
}

Add profiles to a group by automation mappings

post

Adds profiles to a group based on automation mappings.

Body

application/json

group_idintegerRequired

The ID of the group.

Example: 257

company_idintegerRequired

The ID of the company.

Example: 385

automation_mappingsobjectRequired

An object containing automation mappings to filter profiles.

Example: {"department":"IT","job":"Engineer"}

Responses

200

Profiles addition success response

application/json

post

/company/group/profiles

HTTPcURLJavaScriptPython

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

{
  "group_id": 257,
  "company_id": 385,
  "automation_mappings": {
    "department": "IT",
    "job": "Engineer"
  }
}

200

Profiles addition success response

{
  "status": "success"
}