Sign in
Team Membership

List Team Users

Returns a paginated list of users that belong to the team specified in the path parameter.

get/v3/teams/{teamId}/users

Query parameters

page[size]integer
Example:10

The maximum number of items to include per page. The last page of a collection may include fewer items.

page[number]integer
Example:1

Determines which page of the entities to retrieve.

activeboolean

Filter by a boolean value (true/false).

Filter users returned in the response.

Response

A paginated list response for a collection of users.

Example response

{
  "meta": {
    "page": {
      "number": 1,
      "size": 10,
      "total": 100
    }
  },
  "data": [
    {
      "id": "7f9fd312-a987-4628-b4c5-bb4f4fddd5f7",
      "email": "user@email.com",
      "full_name": "Test User",
      "preferred_name": "test",
      "active": true,
      "inferred_region": "us",
      "created_at": "2022-02-07T17:46:57.52Z",
      "updated_at": "2022-10-08T17:00:00.52Z"
    }
  ]
}

Changes

Changed in 5 of the 75 revisions of this API.1143

  • 8ab3ec3ed3011See the full diff
    • ●

      added the new type enum value to the /////// response property for the response status

      response-property-enum-value-added

  • 396c243e49dc1See the full diff
    • ●

      for the query request parameter filter, the type of property id changed from string to no type

      request-parameter-property-type-changed

    This revision also has 6 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 3c0154b2053a91See the full diff
    • ▲

      the response property /////// became nullable for the status

      response-property-became-nullable

    • ▲

      the response property /////// became nullable for the status

      response-property-became-nullable

    • ▲

      the response property /////// became nullable for the status

      response-property-became-nullable

    • ▲

      the response property /////// became nullable for the status

      response-property-became-nullable

    • ▲

      the response property /////// became nullable for the status

      response-property-became-nullable

    • ▲

      the response property became nullable for the status

      response-property-became-nullable

    • ▲

      the response property // became nullable for the status

      response-property-became-nullable

    • ▲

      the response property // became nullable for the status

      response-property-became-nullable

    • ▲

      the response property // became nullable for the status

      response-property-became-nullable

    • ○

      the response's property default value true was added for the status

      response-property-default-value-added

    This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 6333a0d3b09521See the full diff
    • ▲

      for the query request parameter filter, the type of property email was specialized from no type to object

      request-parameter-property-type-specialized

    • ▲

      for the query request parameter filter, the type of property full_name was specialized from no type to object

      request-parameter-property-type-specialized

    • ○

      the response's property default value true was removed for the status

      response-property-default-value-removed

    This revision also has 15 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 76b0fefddb0d21See the full diff
    • ●

      for the query request parameter filter, the type of property email changed from object to no type

      request-parameter-property-type-changed

    • ●

      for the query request parameter filter, the type of property full_name changed from object to no type

      request-parameter-property-type-changed

    • ○

      the response's property default value true was added for the status

      response-property-default-value-added