Get users' count

GET/users/count

Get users’ count for a specific company

Example

Use resource IDs from your own project. Keep the API token in your server or CI environment.

TypeScript SDK

example.ts

import { createConfiguration, UsersApi } from '@testcollab/sdk';

const config = createConfiguration(process.env.TESTCOLLAB_TOKEN!);
const api = new UsersApi(config);

const result = await api.getUsersCount({
  "company": 123
});
console.log(result);

HTTP

curl --request GET \
  "https://api.testcollab.io/users/count?token=$TESTCOLLAB_TOKEN&company=123"

Parameters

Name	Location	Type	Required	Description
company	query	number	Yes	Company ID
_filter	query	string	No	Stringified filter object (the filtering guide)

Response

200 — Count of users

Field	Type	Required	Description
count	number	Yes	—

Illustrative response

{
  "count": 123
}

Errors

Status	Meaning
401	Unauthorized
403	Forbidden
404	Not found
500	Internal server error

Next steps

• Browse projects and people
• Authentication
• Handle errors