HEhexclave
Teams

List teams

Changed on

List all the teams that the current user is a member of. user_id=me must be passed in the query parameters.

get/teams

Request

  • Base URL
    https://api.hexclave.com/api/v1
  • URL
    https://api.hexclave.com/api/v1/teams
  • Auth
    none declared

Query parameters

user_idstring

Filter for the teams that the user is a member of. Can be either me or an ID. Must be me in the client API

Example:me
order_by'created_at'

Field to order results by. Currently only created_at is supported.

Example:created_at
desc'true' | 'false'

Whether to order results in descending order. Defaults to false (ascending).

Example:false
limitinteger

The maximum number of items to return (capped at 200). If omitted, all matching teams are returned unpaginated, unless more than 500 teams match, in which case the request fails with a 400 error; set limit and follow pagination.next_cursor instead.

cursorstring

The cursor to start the result set from. Requires limit to also be set.

querystring

A search query to filter the results by. Free-text search applied to the team's id (exact-match) and display name.

Response

Successful response

Example response

{
  "items": [
    {
      "id": "ad962777-8244-496a-b6a2-e0c6a449c79e",
      "display_name": "My Team",
      "profile_image_url": "https://example.com/image.jpg",
      "client_metadata": {
        "key": "value"
      },
      "client_read_only_metadata": {
        "key": "value"
      }
    }
  ],
  "pagination": {
    "next_cursor": "b3d396b8-c574-4c80-97b3-50031675ceb2"
  }
}

Changes

  • fc669d833a13Revision changes
    • breaking

      the response property // became nullable for the status

    • breaking

      the response property // became nullable for the status

    • breaking

      the response property // became nullable for the status

    • breaking

      the response property / became nullable for the status

    • warning

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

    • warning

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

  • f135fd8ca8b4Revision changes
    • info

      added the new optional query request parameter cursor

    • info

      added the new optional query request parameter desc

    • info

      added the new optional query request parameter limit

    • info

      added the new optional query request parameter order_by

    • info

      added the new optional query request parameter query