MergeHRISClient.Api.Teams.teams_retrieve

You're seeing just the function teams_retrieve, go back to MergeHRISClient.Api.Teams module for more information.
Link to this function

teams_retrieve(connection, authorization, x_account_token, id, opts \\ [])

View Source

Specs

teams_retrieve(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  String.t(),
  keyword()
) :: {:ok, MergeHRISClient.Model.Team.t()} | {:error, Tesla.Env.t()}

Returns a Team object with the given id.

Parameters

  • connection (MergeHRISClient.Connection): Connection to server
  • authorization (String.t): Should include 'Bearer ' followed by your production API Key.
  • x_account_token (String.t): Token identifying the end user.
  • id (String.t):
  • opts (KeywordList): [optional] Optional parameters
    • :include_remote_data (boolean()): Whether to include the original data Merge fetched from the third-party to produce these models.

      Returns

on success {:error, Tesla.Env.t} on failure