Enable company admins to effectively view and manage company members at scale. These endpoints can be used to retrieve useful information about the company members, and license details for companies under Member Pricing.

Authorization

These endpoints require an API key with Member Information scope generated for your company to use. If you need help creating an API key, follow our Create API keys guide.

To use it, add an API key in the Authenticate header in your API tool with the apikey schema.

The syntax is:

Key: Authorization
Value: apikey {your API key here}

GET company members

The company members endpoint returns a list of all company members with the following attributes: username, name, email, license, and status.

This endpoint is paginated using the limit and next parameters.

Parameter	Description
`limit`	Maximum number of results to be returned by the endpoint.
`next`	Token to get the next page of items.

Response example:

{
  "value": [
    {
      "username": "udf658a6b4aa9b66fd7924182",
      "name": "John",
      "surname": "Doe",
      "email": "[email protected]",
      "license": "Limited",
      "status": "active"
    }
  ],
  "next": "string"
}

GET company member

Get information from a specific user from your company by username.

Parameter	Description
`username`	Member's username. To retrieve the username of a member, use the reporting API (userAltId* attribute response).*

Response example:

{
"username": "udf658a6b4aa9b66fd7924182",
"name": "John",
"surname": "Doe",
"email": "[email protected]",
"license": "Limited",
"status": "active"
}

GET members summary

Get the total number of members and the summary of licenses assigned for companies under the Member pricing plan. This data is updated every hour, and the response contains the last time it was refreshed.

Response example:

{
  "totalMembers": 100,
  "licenses": [
    {
      "id": "b1ae35180681a36dexxxxxxx",
      "displayName": "Limited",
      "count": 100
    }
  ],
  "lastRefreshedAt": "2024-02-28T14:00:00.000Z"
}

Additional information

The Member information API uses rate limiting to prevent server overload. If your app sends more than 25 requests per second, you’ll receive a 429 error.
The GET members endpoint is paginated and returns a maximum of 100 records per request.
- The number of results can be configured through the limit parameter.
- The next token has to be saved from the response and passed to the subsequent request to get the next page of results.
- For more information and error responses, please follow this Get a list of company members API reference.
Read more about our Member pricing plan on our help center.