Search Users | termina | Documentation

Search users who have access to this deal.

Requires READER role or above on the deal. By default, users with either group or direct deal access are returned. Set only_direct to true to limit results to users with direct deal access only.

Args: text: Optional case-insensitive search across user name and email

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path Parameters

deal_idintegerRequired

Query Parameters

textstring or nullOptional

only_directbooleanOptionalDefaults to false

When true, returns only users with direct access to the deal (excludes group access)

sort_bystring or nullOptional

sort_orderstringOptionalformat: "^(asc|desc)$"Defaults to asc

pageintegerOptional>=1Defaults to 1

page_sizeintegerOptional>=1Defaults to 100

Response

Successful Response

total_countinteger

pageinteger

page_sizeinteger

datalist of objects

1	import requests
2
3	url = "https://app.termina.ai/api/v1/deal/1/search-users"
4
5	headers = {"Authorization": "Bearer <token>"}
6
7	response = requests.get(url, headers=headers)
8
9	print(response.json())

1	{
2	"total_count": 1,
3	"page": 1,
4	"page_size": 1,
5	"data": [
6	{
7	"id": 1,
8	"name": "string",
9	"email": "string",
10	"thumbnail_url": "string",
11	"role": "admin"
12	}
13	]
14	}

Authentication

Path Parameters

Query Parameters

Response

Errors