Users AI Tools

Open in ChatGPT

Open in ChatGPT to ask questions about this page

Open in Claude

Open in Claude to ask questions about this page

Copy as Markdown

Copy this page as markdown to use with AI assistants

View as Markdown

Open this page as markdown in a new tab

Users are members of an organization registered in Cliq. The User object represents a user’s profile and the associated attributes within the organization. Using the User APIs, you can retrieve all users in the organization, fetch detailed user information, add new users, update user profiles, and access team-related information.

Download Users OpenAPI Document

End Points

POST

/users/{USER_ID}/teams

GET

/users/layout

Add Users AI Tools

Open in ChatGPT

Open in ChatGPT to ask questions about this page

Open in Claude

Open in Claude to ask questions about this page

Copy as Markdown

Copy this page as markdown to use with AI assistants

View as Markdown

Open this page as markdown in a new tab

Use this API to add a new user or a list of new users.

Threshold limit: 5 requests per minute per user
Number of API calls allowed within a minute.

Lock period: 5 minutes
Wait time before consecutive API requests.

Note: When adding users, you might encounter errors for certain email IDs. The table below lists the possible error codes and their descriptions to help you understand and resolve these issues effectively.

Error Code	Description
zohoaccount.conflict	The user has an existing Cliq account with the same email ID. Use a different email to invite.
email.invitation.blocked	The user has rejected the invitation multiple times. Try a different email ID.
email.activeuser	The user is already part of your Cliq organization.
email.pendinguser	An invitation is already pending. Reinvite from the admin panel if needed.

OAuth Scope : ZohoCliq.Users.CREATE

Arguments

users

array

Array of user objects to be created or updated.

Show Sub-Attributes

email_id

(Required)

The email ID of the user. (Mandatory)

first_name

string

The first name of the user.

last_name

string

The last name of the user.

display_name

string

The display name of the user.

phone

string

Phone number of the user.

mobile

string

Mobile number of the user.

timezone

string

User's timezone.

language

string

User's default language.

country

string

Country code of the user.

designation_id

string

ID of the designation to be associated with the user.

department_id

string

ID of the department where the user will be added.

reporting_to_zuid

string

User ID of the reporting manager.

work_location

string

Work location of the user.

extension

string

The user's extension/desk phone number.

employee_id

string

The user's employee ID.

image_data

byte

The profile picture of the user in Base64 format.

channel_ids

array

IDs of the channels the user will be added to.

team_ids

array

IDs of the teams the user will be added to. To retrieve team IDs, use the List all teams API.

Custom_Field_UniqueName

string

Unique name of a custom user field.

Note: This is not a static value and can change according to the user-defined field name.
Example: For a custom user field "Workplace Name", provide its unique name as the key and the desired value.

Request Example

parameters_data='{"field1":"value1","field2":"value2"}';
headers_data = Map();
headers_data.put("Authorization", "Bearer 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f");
response = invokeUrl
[
url: "https://cliq.zoho.com/api/v2/users"
type: POST
headers: headers_data
content-type: application/json
parameters: parameters_data
connection: <connection_name>
];
info response;

OkHttpClient client = new OkHttpClient();

MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\"field1\":\"value1\",\"field2\":\"value2\"}");
Request request = new Request.Builder()
  .url("https://cliq.zoho.com/api/v2/users")
  .post(body)
  .addHeader("Authorization", "Bearer 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f")
  .addHeader("content-type", "application/json")
  .build();

Response response = client.newCall(request).execute();

const options = {
  method: 'POST',
  headers: {
    Authorization: 'Bearer 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f',
    'content-type': 'application/json'
  },
  body: '{"field1":"value1","field2":"value2"}'
};

fetch('https://cliq.zoho.com/api/v2/users', options)
  .then(response => response.json())
  .then(response => console.log(response))
  .catch(err => console.error(err));

import http.client

conn = http.client.HTTPSConnection("cliq.zoho.com")

payload = "{\"field1\":\"value1\",\"field2\":\"value2\"}"

headers = {
    'Authorization': "Bearer 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f",
    'content-type': "application/json"
    }

conn.request("POST", "/api/v2/users", payload, headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

const http = require("https");

const options = {
  "method": "POST",
  "hostname": "cliq.zoho.com",
  "port": null,
  "path": "/api/v2/users",
  "headers": {
    "Authorization": "Bearer 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f",
    "content-type": "application/json"
  }
};

const req = http.request(options, function (res) {
  const chunks = [];

  res.on("data", function (chunk) {
    chunks.push(chunk);
  });

  res.on("end", function () {
    const body = Buffer.concat(chunks);
    console.log(body.toString());
  });
});

req.write(JSON.stringify({field1: 'value1', field2: 'value2'}));
req.end();

var client = new RestClient("https://cliq.zoho.com/api/v2/users");
var request = new RestRequest(Method.POST);
request.AddHeader("Authorization", "Bearer 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f");
request.AddHeader("content-type", "application/json");
request.AddParameter("application/json", "{\"field1\":\"value1\",\"field2\":\"value2\"}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

var client = new HttpClient();
var request = new HttpRequestMessage
{
    Method = HttpMethod.Post,
    RequestUri = new Uri("https://cliq.zoho.com/api/v2/users"),
    Headers =
    {
        { "Authorization", "Bearer 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f" },
    },
    Content = new StringContent("{\"field1\":\"value1\",\"field2\":\"value2\"}")
    {
        Headers =
        {
            ContentType = new MediaTypeHeaderValue("application/json")
        }
    }
};
using (var response = await client.SendAsync(request))
{
    response.EnsureSuccessStatusCode();
    var body = await response.Content.ReadAsStringAsync();
    Console.WriteLine(body);
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "https://cliq.zoho.com/api/v2/users"

	payload := strings.NewReader("{\"field1\":\"value1\",\"field2\":\"value2\"}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f")
	req.Header.Add("content-type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

const data = JSON.stringify({
  "field1": "value1",
  "field2": "value2"
});

const xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://cliq.zoho.com/api/v2/users");
xhr.setRequestHeader("Authorization", "Bearer 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f");
xhr.setRequestHeader("content-type", "application/json");

xhr.send(data);

curl --request POST \
  --url https://cliq.zoho.com/api/v2/users \
  --header 'Authorization: Bearer 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f' \
  --header 'content-type: application/json' \
  --data '{"field1":"value1","field2":"value2"}'

{
    "users": [
        {
            "email_id": "amy@zylker.com",
            "first_name": "Amy",
            "last_name": "Smith",
            "display_name": "Amy Smith",
            "phone": "04412345678",
            "mobile": "9876543210",
            "timezone": "Asia/Kolkata",
            "language": "en",
            "country": "IN",
            "designation_id": "D123456",
            "department_id": "Dept789",
            "reporting_to_zuid": "ZU_1234567890",
            "work_location": "Chennai Office",
            "extension": "4021",
            "employee_id": "EMP1234",
            "image_data": "string",
            "channel_ids": [
                "O1864232000000076001",
                "02436281894678923571"
            ],
            "team_ids": [
                "674269993",
                "122347899"
            ],
            "Custom_Field_UniqueName": "workplace_name"
        }
    ]
}

Response Example

{
    "data": {
        "success_users": [
            "amy@zylker.com",
            "riyaan@zylker.com"
        ],
        "failed_users": {...}
    }
}

{
    "message": "The request cannot be performed. Usually because of malformed parameter or missing parameter."
}

{
    "message": "Request was rejected because of invalid AuthToken."
}

{
    "message": "The user does not have enough permission or possibly not an user of the respective organization to access the resource."
}

{
    "message": "The URL you've sent is wrong. It's possible that the resource you've requested has been moved to another URL."
}

{
    "message": "The requested resource does not support the HTTP method used. For example, requesting List of all customers API with PUT as the HTTP method."
}

{
    "message": "The response has been received but the requested response type is not supported by the browser."
}

{
    "message": "Too many requests within a certain time frame."
}

{
    "message": "Cliq server encountered an error which prevents it from fulfilling the request."
}

Retrieve all users AI Tools

Open in ChatGPT

Open in ChatGPT to ask questions about this page

Open in Claude

Open in Claude to ask questions about this page

Copy as Markdown

Copy this page as markdown to use with AI assistants

View as Markdown

Open this page as markdown in a new tab

Use this API to get details of all the users.

Threshold limit: 30 requests per min per user
Number of API calls allowed within a minute.

Lock period: 10 minutes
Wait time before consecutive API requests.

OAuth Scope : ZohoCliq.Users.READ,ZohoPeople.forms.READ,ZohoPeople.employee.READ,ZohoPeople.attendance.READ

Query Parameters

status

string

Use this parameter to fetch the list of users based on their current status. Allowed values:

active - User is currently active in the organization.
inactive - User is manually marked as inactive.
pending - Invitation sent, but user hasn't accepted yet.
imported_active - User imported from another Zoho service and is active.
imported_inactive - User imported but marked as inactive.

plan_type

string

Use this parameter to filter users based on their subscription type. Allowed values:

paid - User is under a paid subscription plan.
free - User is under a free version of the plan.

fields

string

Use this parameter to specify which user fields to return. Multiple fields can be comma-separated. Use fields=all to return all fields. Allowed values:

display_name - Display name of the user.
mobile - Mobile number of the user.
department - Department the user belongs to.
designation - Job title or role of the user.
all - All available user fields will be returned.

limit

integer

The number of users to fetch. Maximum is 100.

string

A text string to search users by name or email address. If Zoho People is integrated, search includes all its user fields.

sort_by

string

Use this parameter to sort the users based on specific criteria. Allowed values: usage - Sort users based on their activity or usage in Cliq.

modified_after

date-time

Fetch users whose fields were modified after this timestamp.
Only changes in the following fields are considered: Department, Designation, Employee ID, Extension, Reporting To, and Work Location.
Note: Only modifications within the last 7 days are available.

next_token

string

Use this token to paginate and retrieve the next batch of user results.

Request Example

headers_data = Map();
headers_data.put("Authorization", "Bearer 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f");
response = invokeUrl
[
url: "https://cliq.zoho.com/api/v2/users"
type: GET
headers: headers_data
connection: <connection_name>
];
info response;

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://cliq.zoho.com/api/v2/users")
  .get()
  .addHeader("Authorization", "Bearer 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f")
  .build();

Response response = client.newCall(request).execute();

const options = {
  method: 'GET',
  headers: {
    Authorization: 'Bearer 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'
  }
};

fetch('https://cliq.zoho.com/api/v2/users', options)
  .then(response => response.json())
  .then(response => console.log(response))
  .catch(err => console.error(err));

import http.client

conn = http.client.HTTPSConnection("cliq.zoho.com")

headers = { 'Authorization': "Bearer 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f" }

conn.request("GET", "/api/v2/users", headers=headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

const http = require("https");

const options = {
  "method": "GET",
  "hostname": "cliq.zoho.com",
  "port": null,
  "path": "/api/v2/users",
  "headers": {
    "Authorization": "Bearer 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f"
  }
};

const req = http.request(options, function (res) {
  const chunks = [];

  res.on("data", function (chunk) {
    chunks.push(chunk);
  });

  res.on("end", function () {
    const body = Buffer.concat(chunks);
    console.log(body.toString());
  });
});

req.end();

var client = new RestClient("https://cliq.zoho.com/api/v2/users");
var request = new RestRequest(Method.GET);
request.AddHeader("Authorization", "Bearer 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f");
IRestResponse response = client.Execute(request);

var client = new HttpClient();
var request = new HttpRequestMessage
{
    Method = HttpMethod.Get,
    RequestUri = new Uri("https://cliq.zoho.com/api/v2/users"),
    Headers =
    {
        { "Authorization", "Bearer 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f" },
    },
};
using (var response = await client.SendAsync(request))
{
    response.EnsureSuccessStatusCode();
    var body = await response.Content.ReadAsStringAsync();
    Console.WriteLine(body);
}

package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "https://cliq.zoho.com/api/v2/users"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

const data = null;

const xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://cliq.zoho.com/api/v2/users");
xhr.setRequestHeader("Authorization", "Bearer 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f");

xhr.send(data);

curl --request GET \
  --url https://cliq.zoho.com/api/v2/users \
  --header 'Authorization: Bearer 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'

Response Example

{
    "next_token": "359868eb5dca56ghs721hak082ynoy85hakqovfewjbf41533",
    "has_more": true,
    "data": [
        {
            "email_id": "yoda@zylker.com",
            "zuid": "163315760",
            "zoid": "54107592",
            "display_name": "Yod",
            "name": "Yod Agbaria",
            "organization_id": "631836344",
            "id": "163315760"
        },
        {
            "email_id": "noweit@zylker.com",
            "zuid": "163317679",
            "zoid": "54107592",
            "display_name": "No-Wei",
            "name": "No-Wei Ting",
            "organization_id": "631836344",
            "id": "163317679"
        },
        {...},
        {...}
    ]
}

{
    "message": "The request cannot be performed. Usually because of malformed parameter or missing parameter."
}

{
    "message": "Request was rejected because of invalid AuthToken."
}

{
    "message": "The user does not have enough permission or possibly not an user of the respective organization to access the resource."
}

{
    "message": "The URL you've sent is wrong. It's possible that the resource you've requested has been moved to another URL."
}

{
    "message": "The requested resource does not support the HTTP method used. For example, requesting List of all customers API with PUT as the HTTP method."
}

{
    "message": "The response has been received but the requested response type is not supported by the browser."
}

{
    "message": "Too many requests within a certain time frame."
}

{
    "message": "Cliq server encountered an error which prevents it from fulfilling the request."
}

Update user details AI Tools

Open in ChatGPT

Open in ChatGPT to ask questions about this page

Open in Claude

Open in Claude to ask questions about this page

Copy as Markdown

Copy this page as markdown to use with AI assistants

View as Markdown

Open this page as markdown in a new tab

Use this API to edit or update a user's details.

Threshold limit: 20 requests per min per user
Number of API calls allowed within a minute.

Lock period: 10 minutes
Wait time before consecutive API requests.

Note: For updating profile picture through the API, the scope Profile.orguserphoto.UPDATE should be included.

Error Code	Description
operation_not_allowed	The operation is not allowed because you might be trying to update another user's profile or trying to update a user who does not belong to your Cliq organization.

OAuth Scope : ZohoCliq.Users.UPDATE,Profile.orguserphoto.UPDATE

Arguments

users

array

Array of user objects to be created or updated.

Show Sub-Attributes

email_id

(Required)

The email ID of the user. (Mandatory)

first_name

string

The first name of the user.

last_name

string

The last name of the user.

display_name

string

The display name of the user.

phone

string

Phone number of the user.

mobile

string

Mobile number of the user.

timezone

string

User's timezone.

language

string

User's default language.

country

string

Country code of the user.

designation_id

string

ID of the designation to be associated with the user.

department_id

string

ID of the department where the user will be added.

reporting_to_zuid

string

User ID of the reporting manager.

work_location

string

Work location of the user.

extension

string

The user's extension/desk phone number.

employee_id

string

The user's employee ID.

image_data

byte

The profile picture of the user in Base64 format.

channel_ids

array

IDs of the channels the user will be added to.

team_ids

array

IDs of the teams the user will be added to. To retrieve team IDs, use the List all teams API.

Custom_Field_UniqueName

string

Unique name of a custom user field.

Note: This is not a static value and can change according to the user-defined field name.
Example: For a custom user field "Workplace Name", provide its unique name as the key and the desired value.

Path Parameters

User ID

string

(Required)

Unique identifier of the user whose details needs to be updated To learn how to retrieve this ID, see USER_ID in the Glossary page.

Request Example

parameters_data='{"field1":"value1","field2":"value2"}';
headers_data = Map();
headers_data.put("Authorization", "Bearer 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f");
response = invokeUrl
[
url: "https://cliq.zoho.com/api/v2/users/%7BUSER_ID%7D"
type: PUT
headers: headers_data
content-type: application/json
parameters: parameters_data
connection: <connection_name>
];
info response;

OkHttpClient client = new OkHttpClient();

MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\"field1\":\"value1\",\"field2\":\"value2\"}");
Request request = new Request.Builder()
  .url("https://cliq.zoho.com/api/v2/users/%7BUSER_ID%7D")
  .put(body)
  .addHeader("Authorization", "Bearer 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f")
  .addHeader("content-type", "application/json")
  .build();

Response response = client.newCall(request).execute();

const options = {
  method: 'PUT',
  headers: {
    Authorization: 'Bearer 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f',
    'content-type': 'application/json'
  },
  body: '{"field1":"value1","field2":"value2"}'
};

fetch('https://cliq.zoho.com/api/v2/users/%7BUSER_ID%7D', options)
  .then(response => response.json())
  .then(response => console.log(response))
  .catch(err => console.error(err));

import http.client

conn = http.client.HTTPSConnection("cliq.zoho.com")

payload = "{\"field1\":\"value1\",\"field2\":\"value2\"}"

headers = {
    'Authorization': "Bearer 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f",
    'content-type': "application/json"
    }

conn.request("PUT", "/api/v2/users/%7BUSER_ID%7D", payload, headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

const http = require("https");

const options = {
  "method": "PUT",
  "hostname": "cliq.zoho.com",
  "port": null,
  "path": "/api/v2/users/%7BUSER_ID%7D",
  "headers": {
    "Authorization": "Bearer 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f",
    "content-type": "application/json"
  }
};

const req = http.request(options, function (res) {
  const chunks = [];

  res.on("data", function (chunk) {
    chunks.push(chunk);
  });

  res.on("end", function () {
    const body = Buffer.concat(chunks);
    console.log(body.toString());
  });
});

req.write(JSON.stringify({field1: 'value1', field2: 'value2'}));
req.end();

var client = new RestClient("https://cliq.zoho.com/api/v2/users/%7BUSER_ID%7D");
var request = new RestRequest(Method.PUT);
request.AddHeader("Authorization", "Bearer 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f");
request.AddHeader("content-type", "application/json");
request.AddParameter("application/json", "{\"field1\":\"value1\",\"field2\":\"value2\"}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

var client = new HttpClient();
var request = new HttpRequestMessage
{
    Method = HttpMethod.Put,
    RequestUri = new Uri("https://cliq.zoho.com/api/v2/users/%7BUSER_ID%7D"),
    Headers =
    {
        { "Authorization", "Bearer 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f" },
    },
    Content = new StringContent("{\"field1\":\"value1\",\"field2\":\"value2\"}")
    {
        Headers =
        {
            ContentType = new MediaTypeHeaderValue("application/json")
        }
    }
};
using (var response = await client.SendAsync(request))
{
    response.EnsureSuccessStatusCode();
    var body = await response.Content.ReadAsStringAsync();
    Console.WriteLine(body);
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "https://cliq.zoho.com/api/v2/users/%7BUSER_ID%7D"

	payload := strings.NewReader("{\"field1\":\"value1\",\"field2\":\"value2\"}")

	req, _ := http.NewRequest("PUT", url, payload)

	req.Header.Add("Authorization", "Bearer 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f")
	req.Header.Add("content-type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

const data = JSON.stringify({
  "field1": "value1",
  "field2": "value2"
});

const xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("PUT", "https://cliq.zoho.com/api/v2/users/%7BUSER_ID%7D");
xhr.setRequestHeader("Authorization", "Bearer 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f");
xhr.setRequestHeader("content-type", "application/json");

xhr.send(data);

curl --request PUT \
  --url https://cliq.zoho.com/api/v2/users/%7BUSER_ID%7D \
  --header 'Authorization: Bearer 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f' \
  --header 'content-type: application/json' \
  --data '{"field1":"value1","field2":"value2"}'

{
    "users": [
        {
            "email_id": "amy@zylker.com",
            "first_name": "Amy",
            "last_name": "Smith",
            "display_name": "Amy Smith",
            "phone": "04412345678",
            "mobile": "9876543210",
            "timezone": "Asia/Kolkata",
            "language": "en",
            "country": "IN",
            "designation_id": "D123456",
            "department_id": "Dept789",
            "reporting_to_zuid": "ZU_1234567890",
            "work_location": "Chennai Office",
            "extension": "4021",
            "employee_id": "EMP1234",
            "image_data": "string",
            "channel_ids": [
                "O1864232000000076001",
                "02436281894678923571"
            ],
            "team_ids": [
                "674269993",
                "122347899"
            ],
            "Custom_Field_UniqueName": "workplace_name"
        }
    ]
}

Response Example

{
    "data": {
        "success_users": [
            "amy@zylker.com",
            "riyaan@zylker.com"
        ],
        "failed_users": {...}
    }
}

{
    "message": "The request cannot be performed. Usually because of malformed parameter or missing parameter."
}

{
    "message": "Request was rejected because of invalid AuthToken."
}

{
    "message": "The user does not have enough permission or possibly not an user of the respective organization to access the resource."
}

{
    "message": "The URL you've sent is wrong. It's possible that the resource you've requested has been moved to another URL."
}

{
    "message": "The requested resource does not support the HTTP method used. For example, requesting List of all customers API with PUT as the HTTP method."
}

{
    "message": "The response has been received but the requested response type is not supported by the browser."
}

{
    "message": "Too many requests within a certain time frame."
}

{
    "message": "Cliq server encountered an error which prevents it from fulfilling the request."
}

Retrieve a particular user AI Tools

Open in ChatGPT

Open in ChatGPT to ask questions about this page

Open in Claude

Open in Claude to ask questions about this page

Copy as Markdown

Copy this page as markdown to use with AI assistants

View as Markdown

Open this page as markdown in a new tab

Use this API to get details of a particular user.

Threshold limit: 20 requests per min per user
Number of API calls allowed within a minute.

Lock period: 10 minutes
Wait time before consecutive API requests.

OAuth Scope : ZohoCliq.Users.READ,ZohoPeople.forms.READ,ZohoPeople.employee.READ,ZohoPeople.attendance.READ

Path Parameters

User ID

string

(Required)

Unique identifier of the user to be retrieved To learn how to retrieve this ID, see USER_ID in the Glossary page.

Query Parameters

fields

string

Use this parameter to fetch the list of user fields. If fields=all, returns all the user fields.
Allowed values : display_name|mobile|department|designation.
You can enter multiple fields by seperating them with a comma.

Request Example

headers_data = Map();
headers_data.put("Authorization", "Bearer 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f");
response = invokeUrl
[
url: "https://cliq.zoho.com/api/v2/users/%7BUSER_ID%7D"
type: GET
headers: headers_data
connection: <connection_name>
];
info response;

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://cliq.zoho.com/api/v2/users/%7BUSER_ID%7D")
  .get()
  .addHeader("Authorization", "Bearer 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f")
  .build();

Response response = client.newCall(request).execute();

const options = {
  method: 'GET',
  headers: {
    Authorization: 'Bearer 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'
  }
};

fetch('https://cliq.zoho.com/api/v2/users/%7BUSER_ID%7D', options)
  .then(response => response.json())
  .then(response => console.log(response))
  .catch(err => console.error(err));

import http.client

conn = http.client.HTTPSConnection("cliq.zoho.com")

headers = { 'Authorization': "Bearer 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f" }

conn.request("GET", "/api/v2/users/%7BUSER_ID%7D", headers=headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

const http = require("https");

const options = {
  "method": "GET",
  "hostname": "cliq.zoho.com",
  "port": null,
  "path": "/api/v2/users/%7BUSER_ID%7D",
  "headers": {
    "Authorization": "Bearer 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f"
  }
};

const req = http.request(options, function (res) {
  const chunks = [];

  res.on("data", function (chunk) {
    chunks.push(chunk);
  });

  res.on("end", function () {
    const body = Buffer.concat(chunks);
    console.log(body.toString());
  });
});

req.end();

var client = new RestClient("https://cliq.zoho.com/api/v2/users/%7BUSER_ID%7D");
var request = new RestRequest(Method.GET);
request.AddHeader("Authorization", "Bearer 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f");
IRestResponse response = client.Execute(request);

var client = new HttpClient();
var request = new HttpRequestMessage
{
    Method = HttpMethod.Get,
    RequestUri = new Uri("https://cliq.zoho.com/api/v2/users/%7BUSER_ID%7D"),
    Headers =
    {
        { "Authorization", "Bearer 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f" },
    },
};
using (var response = await client.SendAsync(request))
{
    response.EnsureSuccessStatusCode();
    var body = await response.Content.ReadAsStringAsync();
    Console.WriteLine(body);
}

package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "https://cliq.zoho.com/api/v2/users/%7BUSER_ID%7D"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

const data = null;

const xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://cliq.zoho.com/api/v2/users/%7BUSER_ID%7D");
xhr.setRequestHeader("Authorization", "Bearer 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f");

xhr.send(data);

curl --request GET \
  --url https://cliq.zoho.com/api/v2/users/%7BUSER_ID%7D \
  --header 'Authorization: Bearer 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'

Response Example

{
    "data": {
        "employee_id": "213",
        "first_name": "Scott",
        "reportingto": {
            "name": "Tim Harrison",
            "id": "631831446"
        },
        "mobile": "534 678 1234",
        "zoid": "54107592",
        "organization_id": "631836344",
        "email_id": "scott.fisher@zylker.com",
        "extension": "3129",
        "work_location": "C block, S-H12",
        "id": "631830849",
        "timeoffset": 19800000,
        "timezone": "Asia/Kolkata",
        "language": "English",
        "status": "active",
        "country": "United States",
        "department": {
            "name": "Zylker Corp",
            "id": "1901318000001424001"
        },
        "last_name": "Fisher",
        "full_name": "Scott Fisher",
        "designation": {
            "name": "Leadership Staff",
            "id": "1901318000001072003"
        },
        "display_name": "Scott Fisher",
        "name": "Scott Fisher"
    }
}

{
    "message": "The request cannot be performed. Usually because of malformed parameter or missing parameter."
}

{
    "message": "Request was rejected because of invalid AuthToken."
}

{
    "message": "The user does not have enough permission or possibly not an user of the respective organization to access the resource."
}

{
    "message": "The URL you've sent is wrong. It's possible that the resource you've requested has been moved to another URL."
}

{
    "message": "The requested resource does not support the HTTP method used. For example, requesting List of all customers API with PUT as the HTTP method."
}

{
    "message": "The response has been received but the requested response type is not supported by the browser."
}

{
    "message": "Too many requests within a certain time frame."
}

{
    "message": "Cliq server encountered an error which prevents it from fulfilling the request."
}

Fetch list of user teams AI Tools

Open in ChatGPT

Open in ChatGPT to ask questions about this page

Open in Claude

Open in Claude to ask questions about this page

Copy as Markdown

Copy this page as markdown to use with AI assistants

View as Markdown

Open this page as markdown in a new tab

Use this API to fetch the list of teams that the user belongs to. Head on over here to know more about team object attributes.

Threshold limit: 20 requests per min per user
Number of API calls allowed within a minute.

Lock period: 10 minutes
Wait time before consecutive API requests.

OAuth Scope : ZohoCliq.Users.READ

Path Parameters

User ID

string

(Required)

Unique identifier of the user whose team information need to be retrieved To learn how to retrieve this ID, see USER_ID in the Glossary page.

Request Example

headers_data = Map();
headers_data.put("Authorization", "Bearer 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f");
response = invokeUrl
[
url: "https://cliq.zoho.com/api/v2/users/%7BUSER_ID%7D/teams"
type: GET
headers: headers_data
connection: <connection_name>
];
info response;

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://cliq.zoho.com/api/v2/users/%7BUSER_ID%7D/teams")
  .get()
  .addHeader("Authorization", "Bearer 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f")
  .build();

Response response = client.newCall(request).execute();

const options = {
  method: 'GET',
  headers: {
    Authorization: 'Bearer 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'
  }
};

fetch('https://cliq.zoho.com/api/v2/users/%7BUSER_ID%7D/teams', options)
  .then(response => response.json())
  .then(response => console.log(response))
  .catch(err => console.error(err));

import http.client

conn = http.client.HTTPSConnection("cliq.zoho.com")

headers = { 'Authorization': "Bearer 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f" }

conn.request("GET", "/api/v2/users/%7BUSER_ID%7D/teams", headers=headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

const http = require("https");

const options = {
  "method": "GET",
  "hostname": "cliq.zoho.com",
  "port": null,
  "path": "/api/v2/users/%7BUSER_ID%7D/teams",
  "headers": {
    "Authorization": "Bearer 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f"
  }
};

const req = http.request(options, function (res) {
  const chunks = [];

  res.on("data", function (chunk) {
    chunks.push(chunk);
  });

  res.on("end", function () {
    const body = Buffer.concat(chunks);
    console.log(body.toString());
  });
});

req.end();

var client = new RestClient("https://cliq.zoho.com/api/v2/users/%7BUSER_ID%7D/teams");
var request = new RestRequest(Method.GET);
request.AddHeader("Authorization", "Bearer 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f");
IRestResponse response = client.Execute(request);

var client = new HttpClient();
var request = new HttpRequestMessage
{
    Method = HttpMethod.Get,
    RequestUri = new Uri("https://cliq.zoho.com/api/v2/users/%7BUSER_ID%7D/teams"),
    Headers =
    {
        { "Authorization", "Bearer 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f" },
    },
};
using (var response = await client.SendAsync(request))
{
    response.EnsureSuccessStatusCode();
    var body = await response.Content.ReadAsStringAsync();
    Console.WriteLine(body);
}

package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "https://cliq.zoho.com/api/v2/users/%7BUSER_ID%7D/teams"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

const data = null;

const xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://cliq.zoho.com/api/v2/users/%7BUSER_ID%7D/teams");
xhr.setRequestHeader("Authorization", "Bearer 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f");

xhr.send(data);

curl --request GET \
  --url https://cliq.zoho.com/api/v2/users/%7BUSER_ID%7D/teams \
  --header 'Authorization: Bearer 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'

Response Example

{
    "data": [
        {
            "name": "Zylcal",
            "creation_time": "2017-10-19T08:36:24-07:00",
            "organization_id": "54107592",
            "is_active": true,
            "is_moderator": true,
            "description": "Team working on the Zylker Calendar",
            "team_id": 655249742,
            "joined": true,
            "participant_count": 9
        },
        {
            "name": "Zylker Website Revamp",
            "creation_time": "2019-09-05T21:31:30-07:00",
            "organization_id": "54107592",
            "is_active": true,
            "is_moderator": true,
            "description": "To revamp Zylker's Website",
            "team_id": 695903787,
            "joined": true,
            "participant_count": 5
        },
        {
            "name": "Zylnotes",
            "creation_time": "2019-09-06T04:18:56-07:00",
            "organization_id": "54107592",
            "is_active": true,
            "is_moderator": true,
            "description": "Team for Zylnotes Project",
            "team_id": 695920980,
            "joined": true,
            "participant_count": 6
        }
    ]
}

{
    "message": "The request cannot be performed. Usually because of malformed parameter or missing parameter."
}

{
    "message": "Request was rejected because of invalid AuthToken."
}

{
    "message": "The user does not have enough permission or possibly not an user of the respective organization to access the resource."
}

{
    "message": "The URL you've sent is wrong. It's possible that the resource you've requested has been moved to another URL."
}

{
    "message": "The requested resource does not support the HTTP method used. For example, requesting List of all customers API with PUT as the HTTP method."
}

{
    "message": "The response has been received but the requested response type is not supported by the browser."
}

{
    "message": "Too many requests within a certain time frame."
}

{
    "message": "Cliq server encountered an error which prevents it from fulfilling the request."
}

List user field layouts AI Tools

Open in ChatGPT

Open in ChatGPT to ask questions about this page

Open in Claude

Open in Claude to ask questions about this page

Copy as Markdown

Copy this page as markdown to use with AI assistants

View as Markdown

Open this page as markdown in a new tab

Use this API to fetch the list layouts configured for user fields.

Threshold limit: 10 requests per min per user
Number of API calls allowed within a minute.

Lock period: 10 minutes
Wait time before consecutive API requests.

OAuth Scope : ZohoCliq.Users.READ

Query Parameters

unique_name

string

A unique name identifier for the user field layout. Allowed values:

quick_view - Layout shown in hover cards.
profile_details_android - Layout shown in the Android app user profile.
profile_details_ios - Layout shown in the iOS app user profile.
profile_details_web - Layout shown in the web version user profile.

Request Example

headers_data = Map();
headers_data.put("Authorization", "Bearer 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f");
response = invokeUrl
[
url: "https://cliq.zoho.com/api/v2/users/layout"
type: GET
headers: headers_data
connection: <connection_name>
];
info response;

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://cliq.zoho.com/api/v2/users/layout")
  .get()
  .addHeader("Authorization", "Bearer 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f")
  .build();

Response response = client.newCall(request).execute();

const options = {
  method: 'GET',
  headers: {
    Authorization: 'Bearer 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'
  }
};

fetch('https://cliq.zoho.com/api/v2/users/layout', options)
  .then(response => response.json())
  .then(response => console.log(response))
  .catch(err => console.error(err));

import http.client

conn = http.client.HTTPSConnection("cliq.zoho.com")

headers = { 'Authorization': "Bearer 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f" }

conn.request("GET", "/api/v2/users/layout", headers=headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

const http = require("https");

const options = {
  "method": "GET",
  "hostname": "cliq.zoho.com",
  "port": null,
  "path": "/api/v2/users/layout",
  "headers": {
    "Authorization": "Bearer 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f"
  }
};

const req = http.request(options, function (res) {
  const chunks = [];

  res.on("data", function (chunk) {
    chunks.push(chunk);
  });

  res.on("end", function () {
    const body = Buffer.concat(chunks);
    console.log(body.toString());
  });
});

req.end();

var client = new RestClient("https://cliq.zoho.com/api/v2/users/layout");
var request = new RestRequest(Method.GET);
request.AddHeader("Authorization", "Bearer 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f");
IRestResponse response = client.Execute(request);

var client = new HttpClient();
var request = new HttpRequestMessage
{
    Method = HttpMethod.Get,
    RequestUri = new Uri("https://cliq.zoho.com/api/v2/users/layout"),
    Headers =
    {
        { "Authorization", "Bearer 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f" },
    },
};
using (var response = await client.SendAsync(request))
{
    response.EnsureSuccessStatusCode();
    var body = await response.Content.ReadAsStringAsync();
    Console.WriteLine(body);
}

package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "https://cliq.zoho.com/api/v2/users/layout"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

const data = null;

const xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://cliq.zoho.com/api/v2/users/layout");
xhr.setRequestHeader("Authorization", "Bearer 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f");

xhr.send(data);

curl --request GET \
  --url https://cliq.zoho.com/api/v2/users/layout \
  --header 'Authorization: Bearer 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'

Response Example

{
    "data": [
        {
            "unique_name": "profile_details_android",
            "sections": [
                {
                    "sequence_number": 1,
                    "label": "Work",
                    "unique_name": "work_info",
                    "system_defined": true,
                    "fields": [
                        {
                            "status": "enabled",
                            "sequence_number": 1,
                            "label": "Designation",
                            "unique_name": "designation",
                            "system_defined": true,
                            "id": "1901318000001264017"
                        },
                        {
                            "status": "enabled",
                            "sequence_number": 2,
                            "label": "Department",
                            "unique_name": "department",
                            "system_defined": true,
                            "id": "1901318000001264015"
                        },
                        {
                            "status": "enabled",
                            "sequence_number": 3,
                            "label": "Reporting To",
                            "unique_name": "reportingto",
                            "system_defined": true,
                            "id": "1901318000001264023"
                        },
                        {
                            "status": "enabled",
                            "sequence_number": 4,
                            "label": "Seating Location",
                            "unique_name": "work_location",
                            "system_defined": true,
                            "id": "1901318000001264005"
                        },
                        {
                            "status": "enabled",
                            "sequence_number": 5,
                            "label": "Employee ID",
                            "unique_name": "employee_id",
                            "system_defined": true,
                            "id": "1901318000001264013"
                        },
                        {
                            "status": "enabled",
                            "sequence_number": 6,
                            "label": "Status",
                            "unique_name": "status",
                            "system_defined": true,
                            "id": "1901318000001468001"
                        }
                    ]
                },
                {
                    "sequence_number": 2,
                    "label": "Contact",
                    "unique_name": "contact_info",
                    "system_defined": true,
                    "fields": [
                        {
                            "status": "enabled",
                            "sequence_number": 1,
                            "label": "Phone",
                            "unique_name": "phone",
                            "system_defined": true,
                            "id": "1901318000001705005"
                        },
                        {
                            "status": "enabled",
                            "sequence_number": 2,
                            "label": "Mobile",
                            "unique_name": "mobile",
                            "system_defined": true,
                            "id": "1901318000001264003"
                        },
                        {
                            "status": "enabled",
                            "sequence_number": 3,
                            "label": "Email",
                            "unique_name": "email_id",
                            "system_defined": true,
                            "id": "1901318000001264011"
                        },
                        {
                            "status": "enabled",
                            "sequence_number": 4,
                            "label": "Extension",
                            "unique_name": "extension",
                            "system_defined": true,
                            "id": "1901318000001264019"
                        }
                    ]
                }
            ]
        }
    ]
}

{
    "message": "The request cannot be performed. Usually because of malformed parameter or missing parameter."
}

{
    "message": "Request was rejected because of invalid AuthToken."
}

{
    "message": "The user does not have enough permission or possibly not an user of the respective organization to access the resource."
}

{
    "message": "The URL you've sent is wrong. It's possible that the resource you've requested has been moved to another URL."
}

{
    "message": "The requested resource does not support the HTTP method used. For example, requesting List of all customers API with PUT as the HTTP method."
}

{
    "message": "The response has been received but the requested response type is not supported by the browser."
}

{
    "message": "Too many requests within a certain time frame."
}

{
    "message": "Cliq server encountered an error which prevents it from fulfilling the request."
}

Users AI Tools Open in ChatGPT Open in ChatGPT to ask questions about this page Open in Claude Open in Claude to ask questions about this page Copy as Markdown Copy this page as markdown to use with AI assistants View as Markdown Open this page as markdown in a new tab

Add Users AI Tools Open in ChatGPT Open in ChatGPT to ask questions about this page Open in Claude Open in Claude to ask questions about this page Copy as Markdown Copy this page as markdown to use with AI assistants View as Markdown Open this page as markdown in a new tab

Arguments

Retrieve all users AI Tools Open in ChatGPT Open in ChatGPT to ask questions about this page Open in Claude Open in Claude to ask questions about this page Copy as Markdown Copy this page as markdown to use with AI assistants View as Markdown Open this page as markdown in a new tab

Query Parameters

Update user details AI Tools Open in ChatGPT Open in ChatGPT to ask questions about this page Open in Claude Open in Claude to ask questions about this page Copy as Markdown Copy this page as markdown to use with AI assistants View as Markdown Open this page as markdown in a new tab

Arguments

Path Parameters

Retrieve a particular user AI Tools Open in ChatGPT Open in ChatGPT to ask questions about this page Open in Claude Open in Claude to ask questions about this page Copy as Markdown Copy this page as markdown to use with AI assistants View as Markdown Open this page as markdown in a new tab

Path Parameters

Query Parameters

Fetch list of user teams AI Tools Open in ChatGPT Open in ChatGPT to ask questions about this page Open in Claude Open in Claude to ask questions about this page Copy as Markdown Copy this page as markdown to use with AI assistants View as Markdown Open this page as markdown in a new tab

Path Parameters

List user field layouts AI Tools Open in ChatGPT Open in ChatGPT to ask questions about this page Open in Claude Open in Claude to ask questions about this page Copy as Markdown Copy this page as markdown to use with AI assistants View as Markdown Open this page as markdown in a new tab

Query Parameters

Users AI Tools

Open in ChatGPT

Open in ChatGPT to ask questions about this page

Open in Claude

Open in Claude to ask questions about this page

Copy as Markdown

Copy this page as markdown to use with AI assistants

View as Markdown

Open this page as markdown in a new tab

Add Users AI Tools

Open in ChatGPT

Open in ChatGPT to ask questions about this page

Open in Claude

Open in Claude to ask questions about this page

Copy as Markdown

Copy this page as markdown to use with AI assistants

View as Markdown

Open this page as markdown in a new tab

Retrieve all users AI Tools

Open in ChatGPT

Open in ChatGPT to ask questions about this page

Open in Claude

Open in Claude to ask questions about this page

Copy as Markdown

Copy this page as markdown to use with AI assistants

View as Markdown

Open this page as markdown in a new tab

Update user details AI Tools

Open in ChatGPT

Open in ChatGPT to ask questions about this page

Open in Claude

Open in Claude to ask questions about this page

Copy as Markdown

Copy this page as markdown to use with AI assistants

View as Markdown

Open this page as markdown in a new tab

Retrieve a particular user AI Tools

Open in ChatGPT

Open in ChatGPT to ask questions about this page

Open in Claude

Open in Claude to ask questions about this page

Copy as Markdown

Copy this page as markdown to use with AI assistants

View as Markdown

Open this page as markdown in a new tab

Fetch list of user teams AI Tools

Open in ChatGPT

Open in ChatGPT to ask questions about this page

Open in Claude

Open in Claude to ask questions about this page

Copy as Markdown

Copy this page as markdown to use with AI assistants

View as Markdown

Open this page as markdown in a new tab

List user field layouts AI Tools

Open in ChatGPT

Open in ChatGPT to ask questions about this page

Open in Claude

Open in Claude to ask questions about this page

Copy as Markdown

Copy this page as markdown to use with AI assistants

View as Markdown

Open this page as markdown in a new tab