View Source ExPipedrive.Teams (ex_pipedrive v0.2.0)

API v1 client for Pipedrive legacy teams.

Calls /api/v1/legacyTeams (formerly /api/v1/teams). Read-first surface; team create/update/membership writes are deferred — use ExPipedrive.Raw if needed. The endpoint is marked deprecated by Pipedrive pending a replacement Teams API; behaviour and OAuth scopes (users:read / users:full) are unchanged.

Summary

Functions

get(client, team_id)

Fetches a team via GET /api/v1/legacyTeams/:id.

list(client, opts \\ [])

Lists teams via GET /api/v1/legacyTeams.

list_for_user(client, user_id)

Lists teams for a user via GET /api/v1/legacyTeams/user/:id.

list_users(client, team_id)

Lists user ids in a team via GET /api/v1/legacyTeams/:id/users.

Functions

get(client, team_id)

@spec get(Tesla.Client.t(), pos_integer()) ::
  {:ok, ExPipedrive.Team.t()} | {:error, ExPipedrive.Error.t()}

Fetches a team via GET /api/v1/legacyTeams/:id.

Returns {:ok, %Team{}}.

list(client, opts \\ [])

@spec list(
  Tesla.Client.t(),
  keyword()
) :: {:ok, [ExPipedrive.Team.t()]} | {:error, ExPipedrive.Error.t()}

Lists teams via GET /api/v1/legacyTeams.

Options: :order_by ("id" | "name" | "manager_id" | "active_flag"), :skip_users (true/false or 0/1).

Returns {:ok, [%Team{}]}.

list_for_user(client, user_id)

@spec list_for_user(Tesla.Client.t(), pos_integer()) ::
  {:ok, [ExPipedrive.Team.t()]} | {:error, ExPipedrive.Error.t()}

Lists teams for a user via GET /api/v1/legacyTeams/user/:id.

Returns {:ok, [%Team{}]}.

list_users(client, team_id)

@spec list_users(Tesla.Client.t(), pos_integer()) ::
  {:ok, [pos_integer()]} | {:error, ExPipedrive.Error.t()}

Lists user ids in a team via GET /api/v1/legacyTeams/:id/users.

Returns {:ok, [user_id]}.