Metricool Organization Team Members Api Service API

openapi: 3.2.0
info:
  title: Metricool Organization Team Members Api Service API
  description: 'Metricool API


    The base URL for all endpoints is: https://app.metricool.com/api


    All endpoints require authentication.'
  version: 2.0.0
servers:
- url: https://app.metricool.com/api
tags:
- name: Organization Team Members Api Service
paths:
  /v2/organizations/{organizationId}/team-members:
    get:
      tags:
      - Organization Team Members Api Service
      summary: Get the team members of an organization.
      operationId: getTeamMembers_1
      parameters:
      - name: organizationId
        in: path
        description: Id of the organization
        required: true
        schema:
          type: integer
          format: int64
      responses:
        '200':
          description: Team members retrieved.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JsonOkListResponseOrganizationTeamMemberDto'
        '403':
          description: Caller is not a regular-user session, the organization permissions feature is disabled for the organization's owner, the organization's owner does not hold an Advanced-or-higher plan, or the caller cannot manage team members of this organization.
        '404':
          description: Organization not found, or its owner account could no longer be resolved.
    post:
      tags:
      - Organization Team Members Api Service
      summary: Add a new team member to an organization.
      operationId: addTeamMember
      parameters:
      - name: organizationId
        in: path
        description: Id of the organization
        required: true
        schema:
          type: integer
          format: int64
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AddOrganizationTeamMemberRequest'
        required: true
      responses:
        '200':
          description: Team member added.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JsonOkResponseOrganizationTeamMemberDto'
        '400':
          description: Invalid request body, the target is already a team member or the organization's own owner, or roleId is neither a system role nor one of the organization owner's own.
        '403':
          description: Caller is not a regular-user session, the organization permissions feature is disabled for the organization's owner, the organization's owner does not hold an Advanced-or-higher plan, or the caller cannot manage team members of this organization.
        '404':
          description: Organization not found, or its owner account could no longer be resolved.
  /v2/organizations/{organizationId}/team-members/{userId}:
    delete:
      tags:
      - Organization Team Members Api Service
      summary: Remove a team member from an organization.
      operationId: removeTeamMember
      parameters:
      - name: organizationId
        in: path
        description: Id of the organization
        required: true
        schema:
          type: integer
          format: int64
      - name: userId
        in: path
        description: User id of the team member
        required: true
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: Team member removed.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JsonOkResponseBoolean'
        '403':
          description: Caller is not a regular-user session, the organization permissions feature is disabled for the organization's owner, the organization's owner does not hold an Advanced-or-higher plan, or the caller cannot manage team members of this organization.
        '404':
          description: Organization not found, its owner account could no longer be resolved, or userId is not a team member of it.
    patch:
      tags:
      - Organization Team Members Api Service
      summary: Change the role of an existing team member of an organization.
      operationId: updateTeamMemberRole
      parameters:
      - name: organizationId
        in: path
        description: Id of the organization
        required: true
        schema:
          type: integer
          format: int64
      - name: userId
        in: path
        description: User id of the team member
        required: true
        schema:
          type: integer
          format: int32
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateOrganizationTeamMemberRequest'
        required: true
      responses:
        '200':
          description: Role updated.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JsonOkResponseOrganizationTeamMemberDto'
        '400':
          description: roleId is neither a system role nor one of the organization owner's own.
        '403':
          description: Caller is not a regular-user session, the organization permissions feature is disabled for the organization's owner, the organization's owner does not hold an Advanced-or-higher plan, the caller cannot manage team members of this organization, or userId is the caller's own user id.
        '404':
          description: Organization not found, its owner account could no longer be resolved, or userId is not a team member of it.
  /v2/organizations/{organizationId}/team-members/{userId}/activation-link:
    post:
      tags:
      - Organization Team Members Api Service
      summary: Resend the invitation email to an existing team member, subject to a 1 hour…
      operationId: resendInvitation
      parameters:
      - name: organizationId
        in: path
        description: Id of the organization
        required: true
        schema:
          type: integer
          format: int64
      - name: userId
        in: path
        description: User id of the team member
        required: true
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: Invitation resent.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JsonOkResponseBoolean'
        '403':
          description: Caller is not a regular-user session, the organization permissions feature is disabled for the organization's owner, the organization's owner does not hold an Advanced-or-higher plan, the caller cannot manage team members of this organization, or the last invitation was sent less than 1 hour ago.
        '404':
          description: Organization not found, its owner account could no longer be resolved, or userId is not a team member of it.
components:
  schemas:
    AddOrganizationTeamMemberRequest:
      required:
      - email
      - roleId
      type: object
      properties:
        email:
          minLength: 1
          type: string
          description: Email of the user to invite as a team member.
          example: member@example.com
        roleId:
          type: integer
          description: Id of the role to assign to the new team member. Must belong to the organization owner.
          format: int64
          example: 10
      description: Request body to add a new team member to an organization.
    JsonOkListResponseOrganizationTeamMemberDto:
      type: object
      properties:
        metadata:
          type: object
        page:
          $ref: '#/components/schemas/JsonPaging'
        data:
          type: array
          items:
            $ref: '#/components/schemas/OrganizationTeamMemberDto'
    OrganizationTeamMemberDto:
      type: object
      properties:
        id:
          type: integer
          description: Id of this team member row.
          format: int64
          example: 42
        userId:
          type: integer
          description: Metricool user id of the team member.
          format: int32
          example: 1234
        email:
          type: string
          description: Email of the team member.
          example: member@example.com
        fullName:
          type:
          - string
          - 'null'
          description: 'First and last name of the team member''s account, as collaborators carry it. Null when the account has no name: the front then shows the email.'
          example: Ana García
        profilePicture:
          type:
          - string
          - 'null'
          description: URL of the team member's profile picture. Null when they have none, and the front shows their initials instead.
          example: https://cdn.metricool.com/avatars/1234.png
        roleId:
          type: integer
          description: Id of the role assigned to this team member.
          format: int64
          example: 10
        enabled:
          type: boolean
          description: 'Whether this team member ROW (the organization membership) is currently active, not whether the underlying Metricool account is enabled. Always true: every read query already filters on enabled = 1, so a removed team member never shows up here with false instead.'
          example: true
        lastInvitationSent:
          $ref: '#/components/schemas/DateTimeInfo'
        createdAt:
          $ref: '#/components/schemas/DateTimeInfo'
      description: A team member of an organization.
    UpdateOrganizationTeamMemberRequest:
      required:
      - roleId
      type: object
      properties:
        roleId:
          type: integer
          description: Id of the new role to assign to this team member. Must belong to the organization owner.
          format: int64
          example: 10
      description: Request body to change the role of an existing team member of an organization.
    JsonOkResponseBoolean:
      type: object
      properties:
        metadata:
          type: object
        page:
          $ref: '#/components/schemas/JsonPaging'
        data:
          type: boolean
    JsonPaging:
      type: object
      properties:
        next:
          type: string
    DateTimeInfo:
      required:
      - dateTime
      type: object
      properties:
        dateTime:
          type: string
          description: 'Local Date-time represented with a certain timezone '
        timezone:
          type: string
          description: Timezone applied to the datetime
    JsonOkResponseOrganizationTeamMemberDto:
      type: object
      properties:
        metadata:
          type: object
        page:
          $ref: '#/components/schemas/JsonPaging'
        data:
          $ref: '#/components/schemas/OrganizationTeamMemberDto'