Teams

>>>

GET /api/v4/teams
List of teams. Last update: 29/10/24

Request headers ↑

Only registered user can perform this action
  Authentication - string - required
    Example of Authentication header : "Bearer TOKEN_FETCHED_FROM_SERVER_DURING_REGISTRATION"

Success response body ↑

[
  {
    "id": 2,
    "name": "team",
    "member_roles_count": 3,
    "admin_roles_count": 1,
    "user_in_team": true,
    "admin_role_for_current_user": true
  },
  ...
]

Params

Param name Description
name
optional

Name of team for search

Validations:

  • Must be a String
filter
optional

user by default

Validations:

  • Must be one of: user, workspace.
sort_type
optional

Validations:

  • Must be one of: created_at, name.
sort_to
optional

Validations:

  • Must be one of: asc, desc.
>>>

GET /api/v4/teams/:id
Get team info. Added: 3/01/25

Request headers ↑

Only registered user can perform this action
  Authentication - string - required
    Example of Authentication header : "Bearer TOKEN_FETCHED_FROM_SERVER_DURING_REGISTRATION"

Success response body ↑

{
  "id": 2,
  "name": "team",
  "user_in_team": true,
  "admin_role_for_current_user": true,
  "users": [
    {
      "id": 1,
      "email": "vincent_muller@ferry.co",
      "user_full_name": "Dianna Morar",
      "avatar_image": null,
      "invited": false,
      "team_role_name": "member"
    },
    ...
  ]
}

Params

Param name Description
id
optional

Validations:

  • Must be a Integer
sort_by
optional

Validations:

  • Must be one of: email, team_role, name.
sort_to
optional

Validations:

  • Must be one of: asc, desc.
>>>

POST /api/v4/teams
Create workspace team

Request headers ↑

Only registered user can perform this action
  Authentication - string - required
    Example of Authentication header : "Bearer TOKEN_FETCHED_FROM_SERVER_DURING_REGISTRATION"

Request body example ↑

{
  "user_emails": [
    "sample_email@gmail.com",
    ...
  ],
  "team": {
    "name": "team"
  }
}

Success response body ↑

{
  "team": {
    "id": 20877,
    "name": "team",
    "member_roles_count": 2,
    "admin_roles_count": 1
  },
  "workspace": {
    "id": 14891,
    "name": "workspace",
    "available_users_count": 30,
    "can_add_new_users": true,
    "can_invite_users_count": 27
  }
}

Params

Param name Description
user_emails
optional

user_emails for inviting to team

Validations:

  • Must be an array of String
team
required

Validations:

  • Must be a Hash
team[name]
required

Name of team

Validations:

  • Must be a String
>>>

PUT /api/v4/teams/:id
Update workspace team

Request headers ↑

Only registered user can perform this action
  Authentication - string - required
    Example of Authentication header : "Bearer TOKEN_FETCHED_FROM_SERVER_DURING_REGISTRATION"

Success response body ↑

{
  "id": 2,
  "name": "updated_team"
}

Params

Param name Description
id
required

ID of current team

Validations:

  • Must be a Integer
team
required

Validations:

  • Must be a Hash
team[name]
required

Name of team

Validations:

  • Must be a String
>>>

DELETE /api/v4/teams/:id
Delete workspace team

Request headers ↑

Only registered user can perform this action
  Authentication - string - required
    Example of Authentication header : "Bearer TOKEN_FETCHED_FROM_SERVER_DURING_REGISTRATION"

Success response body ↑

{
  "success": true
}

Params

Param name Description
id
required

ID of current team

Validations:

  • Must be a Integer
>>>

GET /api/v4/teams/list_for_sharing
List for sharing

Request headers ↑

Only registered user can perform this action
  Authentication - string - required
    Example of Authentication header : "Bearer TOKEN_FETCHED_FROM_SERVER_DURING_REGISTRATION"

Success response body ↑

[
  {
    "id": 1,
    "name": "team",
    "share_with_team": true
  },
  ...
]

Params

Param name Description
type
optional

type of sharing object

Validations:

  • Must be one of: presets, media_files, folders, preset_folders.
id
optional

ID of sharing object

Validations:

  • Must be a Integer
>>>

GET /api/v4/teams/social_accounts_list_for_sharing
List for sharing social accounts

Request headers ↑

Only registered user can perform this action
  Authentication - string - required
    Example of Authentication header : "Bearer TOKEN_FETCHED_FROM_SERVER_DURING_REGISTRATION"

Success response body ↑

[
  {
    "id": 1,
    "name": "team",
    "share_with_team": true
  },
  ...
]

Params

Param name Description
type
optional

type of sharing object

Validations:

  • Must be one of: twitter_accounts, facebook_pages, instagram_accounts.
id
optional

ID of sharing object

Validations:

  • Must be a Integer