List Teams

V2-12387 — New endpoint.

This guide walks you through retrieving the list of teams (groups) configured for your organization. Each entry's id is the UUID you must send as assignedGroupId when creating or updating a transaction.

When to Use

• You want to assign a transaction to a specific team via assignedGroupId on POST / PUT /transactions and need to discover available team IDs.
• You are building an admin UI that needs to list the teams in the caller's organization.

Feature flag

This endpoint is gated by the teamAssignment feature flag. If your organization does not have the flag enabled, the endpoint returns 403 Forbidden with error: "enl-api-403". Contact your account manager to enable team assignment.

Endpoint

GET /teams

Requirements

1. Node.js installed.
2. The axios library:

   npm install axios
3. A valid Bearer token (JWT) for authentication.
4. The teamAssignment feature flag enabled for your organization.

Example Request

const axios = require('axios');

const config = {
  method: 'get',
  url: 'https://public-api.sign.stewart.com/teams',
  headers: {
    Authorization: 'Bearer <accessToken>',
  },
};

axios(config)
  .then((response) => console.log(JSON.stringify(response.data, null, 2)))
  .catch((error) => console.error(error));

Example Response

{
  "data": [
    {
      "id": "8500caa1-eb70-4614-a9a1-020be63e67ad",
      "name": "Closing Team A",
      "description": "Handles residential closings",
      "isUniversalGroup": false,
      "canShareOrders": true
    },
    {
      "id": "9a0c1ed4-5b8c-4f57-9d2a-1f7b3c4d2e9f",
      "name": "Universal Team",
      "description": null,
      "isUniversalGroup": true,
      "canShareOrders": false
    }
  ]
}

Response Fields

Field	Type	Description
id	UUID	Team identifier — use as assignedGroupId when creating or updating a transaction.
name	string	Team display name.
description	string | null	Optional team description.
isUniversalGroup	boolean	Whether members of this team can see all orders in the organization.
canShareOrders	boolean	Whether members of this team can share orders with each other.

Errors

Status	error	Reason
401	enl-api-401	Missing or invalid bearer token.
403	enl-api-403	The teamAssignment feature is not enabled for your organization.