Clients
List Clients
List clients from an organization.
Search
The search query parameter takes a list of words and enables you to only return clients whose code or name contains all those words.
GET /api/v4/clients?organizationId=1&search=goo,compa&fields.root=count HTP/1.1
{
"count": 2,
"items": [
{
"id": 1,
"name": "Google",
"code": "World company"
},
{
"id": 1,
"name": "Google company",
"code": "Alphabet Group"
]
}
GET
/
timmi-project
/
api
/
v4
/
clients
Query Parameters
organizationId
integer
requiredFilter on a single organization unique identifier.
page
integer
default: 1Page number
Required range:
x > 1
limit
integer
default: 10Page size
fields.root
enum<string>
Return total items count (across all pages).
Available options:
count
search
string[]
Comma-separated list of codes / names to search for
code
string
Only returns clients whose code is strictly equal to sent value
Response
200 - application/json
items
object[]
next
string | null
prev
string | null
count
integer | null
Required range:
x > 0
Was this page helpful?