find_apisBrowse and filter every API in the catalog.
get_api_artifactsOne API's artifacts, grouped by type.
get_openapiThe primary OpenAPI for this API.
find_similar_apisAPIs that look like this one.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This API

curl "https://apis.io/api/v1/apis/mammoth-io:mammoth-io-users-support-api"

All apis

curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

openapi: 3.2.0
info:
  title: Mammoth Io Users Support API
  version: 0.1.0
  contact:
    name: Mammoth Analytics
    url: https://mammoth.io
    email: support@mammoth.io
  description: 'Operations tagged Users Support across 2 of this provider''s published API definitions: app.mammoth.io-openapi.json, mammoth-io-openapi.json. Each path carries the servers of the definition it was published in.'
servers:
- url: /api/v2
security:
- bearerAuth: []
- apiKey: []
  apiSecret: []
  workspaceId: []
tags:
- name: Users Support
paths:
  /support/workspaces/{workspace_id}/users:
    get:
      tags:
      - Users Support
      summary: Get users list
      description: Retrieve a list of users within a workspace.
      operationId: GetUserList
      parameters:
      - name: workspace_id
        in: path
        schema:
          type: integer
          minimum: 0.0
          title: Workspace ID
          description: Id of the workspace to work with
          examples:
          - 4
        description: Id of the workspace to work with
        required: true
        deprecated: false
        examples:
          workspace_id-example-1:
            summary: Sample workspace ID
            value: 4
      - name: limit
        in: query
        schema:
          type: integer
          maximum: 100.0
          minimum: 0.0
          title: Limit
          description: Max number of result to return
          default: 10
          examples:
          - 10
        description: Max number of result to return
        required: false
        deprecated: false
        allowEmptyValue: false
        allowReserved: false
        examples:
          limit-example-1:
            summary: Limit returned result count to 10
            value: 10
      - name: offset
        in: query
        schema:
          type: integer
          minimum: 0.0
          title: Offset
          description: Distance from the beginning of the list of results
          default: 0
          examples:
          - 0
        description: Distance from the beginning of the list of results
        required: false
        deprecated: false
        allowEmptyValue: false
        allowReserved: false
        examples:
          offset-example-1:
            summary: Start from 10th result
            value: 0
      - name: fields
        in: query
        schema:
          type: string
          title: Fields
          description: Fields to return. Can be (id, email)
          default: __standard
          examples:
          - id,email
        description: Fields to return. Can be (id, email)
        required: false
        deprecated: false
        allowEmptyValue: false
        allowReserved: false
        examples:
          fields-example-1:
            summary: Return only id and email in the result
            value: id,email
      - name: sort
        in: query
        schema:
          oneOf:
          - type: string
          - type: 'null'
          title: Order by column name
          description: Returned users from a workspaces based on this parameter, User format '(field:asc)' for ascending and  '(field:desc)' for descending order.
          examples:
          - (email:asc),(id:desc)
        description: Returned users from a workspaces based on this parameter, User format '(field:asc)' for ascending and  '(field:desc)' for descending order.
        required: false
        deprecated: false
        allowEmptyValue: false
        allowReserved: false
        examples:
          sort-example-1:
            summary: Order by user.email ascending and user.id descending
            value: (email:asc),(id:desc)
      responses:
        '200':
          description: List of users
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UserList'
        '400':
          description: Bad Request
        '401':
          description: Authorization error
      deprecated: false
    post:
      tags:
      - Users Support
      summary: Add a user to the workspace
      description: Add a user into the specified workspace
      operationId: AddUserToWorkspace
      parameters:
      - name: workspace_id
        in: path
        schema:
          type: integer
          minimum: 0.0
          title: Workspace ID
          description: Id of the workspace to work with
          examples:
          - 4
        description: Id of the workspace to work with
        required: true
        deprecated: false
        examples:
          workspace_id-example-1:
            summary: Sample workspace ID
            value: 4
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AddUserSupport'
        required: true
      responses:
        '201':
          description: Document created, URL follows
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UserPostSchema'
        '400':
          description: Bad Request
        '202':
          description: Request Accepted
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UserPostSchema'
        '401':
          description: Authorization error
      deprecated: false
    patch:
      tags:
      - Users Support
      summary: Transfer workspace ownership
      description: Transfer workspace ownership to another user
      operationId: TransferUserRoles
      parameters:
      - name: workspace_id
        in: path
        schema:
          type: integer
          minimum: 0.0
          title: Workspace ID
          description: Id of the workspace to work with
          examples:
          - 4
        description: Id of the workspace to work with
        required: true
        deprecated: false
        examples:
          workspace_id-example-1:
            summary: Sample workspace ID
            value: 4
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/WorkspaceUserPatch'
        required: true
      responses:
        '200':
          description: Successful patch
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UserList'
        '400':
          description: Bad Request
        '401':
          description: Authorization error
      deprecated: false
    servers:
    - url: /api/v2
  /support/workspaces/{workspace_id}/users/invites/{invite_id}:
    delete:
      tags:
      - Users Support
      summary: Cancel a pending workspace invite
      operationId: SupportCancelWorkspaceInvite
      parameters:
      - name: workspace_id
        in: path
        schema:
          type: integer
          minimum: 0.0
          title: Workspace ID
          description: Id of the workspace to work with
          examples:
          - 4
        description: Id of the workspace to work with
        required: true
        deprecated: false
        examples:
          workspace_id-example-1:
            summary: Sample workspace ID
            value: 4
      - name: invite_id
        in: path
        schema:
          type: integer
        required: true
        deprecated: false
      responses:
        '200':
          description: Request fulfilled, document follows
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InviteMessage'
        '400':
          description: Bad request syntax or unsupported method
          content:
            application/json:
              schema:
                properties:
                  status_code:
                    type: integer
                  detail:
                    type: string
                  extra:
                    additionalProperties: {}
                    type:
                    - 'null'
                    - object
                    - array
                type: object
                required:
                - detail
                - status_code
                description: Validation Exception
                examples:
                - status_code: 400
                  detail: Bad Request
                  extra: {}
      deprecated: false
    servers:
    - url: /api/v2
  /support/workspaces/{workspace_id}/users/{user_id}:
    delete:
      tags:
      - Users Support
      summary: Remove a user in a workspace
      description: Remove a user from the specified workspace.
      operationId: RemoveWorkspaceUser
      parameters:
      - name: workspace_id
        in: path
        schema:
          type: integer
          minimum: 0.0
          title: Workspace ID
          description: Id of the workspace to work with
          examples:
          - 4
        description: Id of the workspace to work with
        required: true
        deprecated: false
        examples:
          workspace_id-example-1:
            summary: Sample workspace ID
            value: 4
      - name: user_id
        in: path
        schema:
          type: integer
          minimum: 0.0
          title: User ID
          description: Id of the user to work with
          examples:
          - 4
        description: Id of the user to work with
        required: true
        deprecated: false
        examples:
          user_id-example-1:
            summary: Sample user ID
            value: 4
      responses:
        '204':
          description: Request fulfilled, nothing follows
          headers: {}
        '400':
          description: Bad Request
        '200':
          description: Successful delete
        '401':
          description: Authorization error
      deprecated: false
    servers:
    - url: /api/v2
  /support/workspaces/{workspace_id}/users/invites/{invite_id}/resend:
    post:
      tags:
      - Users Support
      summary: Resend a pending workspace invite
      operationId: SupportResendWorkspaceInvite
      parameters:
      - name: workspace_id
        in: path
        schema:
          type: integer
          minimum: 0.0
          title: Workspace ID
          description: Id of the workspace to work with
          examples:
          - 4
        description: Id of the workspace to work with
        required: true
        deprecated: false
        examples:
          workspace_id-example-1:
            summary: Sample workspace ID
            value: 4
      - name: invite_id
        in: path
        schema:
          type: integer
        required: true
        deprecated: false
      responses:
        '200':
          description: Request fulfilled, document follows
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InviteMessage'
        '400':
          description: Bad request syntax or unsupported method
          content:
            application/json:
              schema:
                properties:
                  status_code:
                    type: integer
                  detail:
                    type: string
                  extra:
                    additionalProperties: {}
                    type:
                    - 'null'
                    - object
                    - array
                type: object
                required:
                - detail
                - status_code
                description: Validation Exception
                examples:
                - status_code: 400
                  detail: Bad Request
                  extra: {}
      deprecated: false
    servers:
    - url: /api/v2
components:
  schemas:
    UserStdSchema:
      properties:
        id:
          type: integer
          title: ID
          description: ID of the user
          examples:
          - value: 2
        email:
          type: string
          format: email
          title: Email of the user
          description: Email of the customer
          examples:
          - value: test@gmail.com
        first_name:
          type: string
          title: First name of the user
          description: First name of the user
          examples:
          - value: Sample First Name
        last_updated_at:
          oneOf:
          - type: string
            format: date-time
          - type: 'null'
          title: Last Updated At of the resource
          description: Last Updated At of the user
          examples:
          - summary: Sample Date
            value: '2023-12-20T03:37:40'
        user_name:
          oneOf:
          - type: string
          - type: 'null'
          title: Name
          description: Name of the user
          examples:
          - value: Sample User Name
        last_name:
          oneOf:
          - type: string
          - type: 'null'
          title: Last name of the user
          description: Sample Last Name
          examples:
          - value: Sample Last Name
        user_roles:
          type: object
          title: User Roles of the user
          description: User Roles of the user
          examples:
          - summary: Sample User Roles
            value: '{}'
      type: object
      required:
      - email
      - first_name
      - id
      - user_roles
      title: UserStdSchema
    UserFullSchema:
      properties:
        id:
          type: integer
          title: ID
          description: ID of the user
          examples:
          - value: 2
        email:
          type: string
          format: email
          title: Email of the user
          description: Email of the customer
          examples:
          - value: test@gmail.com
        first_name:
          type: string
          title: First name of the user
          description: First name of the user
          examples:
          - value: Sample First Name
        last_updated_at:
          oneOf:
          - type: string
            format: date-time
          - type: 'null'
          title: Last Updated At of the resource
          description: Last Updated At of the user
          examples:
          - summary: Sample Date
            value: '2023-12-20T03:37:40'
        user_name:
          oneOf:
          - type: string
          - type: 'null'
          title: Name
          description: Name of the user
          examples:
          - value: Sample User Name
        last_name:
          oneOf:
          - type: string
          - type: 'null'
          title: Last name of the user
          description: Sample Last Name
          examples:
          - value: Sample Last Name
        user_roles:
          type: object
          title: User Roles of the user
          description: User Roles of the user
          examples:
          - summary: Sample User Roles
            value: '{}'
        last_login_date:
          oneOf:
          - type: string
            format: date-time
          - type: 'null'
          title: Last Login of the user
          description: Last Login of the user
          examples:
          - summary: '2023-12-20T03:37:40'
            value: '2023-12-20T03:37:40'
        last_app_activity_at:
          oneOf:
          - type: string
            format: date-time
          - type: 'null'
          title: Last Active of the user
          description: Last Active of the user
          examples:
          - summary: Sample Last Active Date
            value: '2023-12-20T03:37:40'
        last_login_from_ip:
          oneOf:
          - type: string
            format: ipv4
            description: IPv4 address
          - type: string
            format: ipv6
            description: IPv6 address
          - type: 'null'
          title: Last Login From IP of the user
          description: Last Login From IP of the user
          examples:
          - summary: Sample Login From IP
            value: 127.0.0.1
        created_at:
          type: string
          format: date-time
          title: Created At
          description: Created At
          examples:
          - summary: Sample Date
            value: '2023-12-20T03:37:40'
      type: object
      required:
      - created_at
      - email
      - first_name
      - id
      - user_roles
      title: UserFullSchema
    UserMinSchema:
      properties:
        id:
          type: integer
          title: ID
          description: ID of the user
          examples:
          - value: 2
        email:
          type: string
          format: email
          title: Email of the user
          description: Email of the customer
          examples:
          - value: test@gmail.com
        first_name:
          type: string
          title: First name of the user
          description: First name of the user
          examples:
          - value: Sample First Name
        last_updated_at:
          oneOf:
          - type: string
            format: date-time
          - type: 'null'
          title: Last Updated At of the resource
          description: Last Updated At of the user
          examples:
          - summary: Sample Date
            value: '2023-12-20T03:37:40'
      type: object
      required:
      - email
      - first_name
      - id
      title: UserMinSchema
    WorkspaceUserPatch:
      properties:
        patch:
          items:
            $ref: '#/components/schemas/AdminWorkspaceUserPatchOp'
          type: array
      type: object
      required:
      - patch
      title: WorkspaceUserPatch
      description: Update/change user roles in the workspace
      examples:
      - patch:
        - op: replace
          path: role
          value:
            user_id: 29
            role: workspace_admin
            remove_role: workspace_owner
        - op: replace
          path: role
          value:
            user_id: 5
            role: workspace_owner
            remove_role: workspace_admin
    UserList:
      properties:
        users:
          items:
            oneOf:
            - $ref: '#/components/schemas/UserFieldSchema'
            - $ref: '#/components/schemas/UserMinSchema'
            - $ref: '#/components/schemas/UserStdSchema'
            - $ref: '#/components/schemas/UserFullSchema'
          type: array
        offset:
          type: integer
          default: 0
        limit:
          type: integer
          default: 50
        next:
          type: string
          description: URI for next page of data
          examples:
          - value: https://server.mammoth.io/api/v2/support/users?limit=50&offset=50
      type: object
      required:
      - next
      - users
      title: UserList
    InviteMessage:
      properties:
        message:
          type: string
      type: object
      required:
      - message
      title: InviteMessage
    AdminWorkspaceUserPatchOp:
      properties:
        op:
          type: string
          title: Operation
          description: Operation to be performed on the workspace
          examples:
          - summary: Sample Operation
            value: replace
        path:
          type: string
          title: Path
          description: Path of the workspace
          examples:
          - summary: Sample Path
            value: name
        value:
          type: object
          title: Value
          description: Value of the workspace
          examples:
          - summary: Sample Value
            value: {}
      type: object
      required:
      - op
      - path
      - value
      title: AdminWorkspaceUserPatchOp
    AddUserSupport:
      properties:
        first_name:
          oneOf:
          - type: string
          - type: 'null'
          title: First name of the user
          description: First name of the user
          examples:
          - summary: Sample First Name
            value: Jacob
        last_name:
          oneOf:
          - type: string
          - type: 'null'
          title: Last name of the user
          description: Last name of the user
          examples:
          - summary: Sample Last Name
            value: van
        email:
          type: string
          format: email
          title: Email of the user
          description: Email of the customer
          examples:
          - value: test@gmail.com
        role:
          type: string
          enum:
          - workspace_member
          - workspace_admin
          - workspace_owner
          - workspace_guest
          title: Role
          description: Role of the user
          examples:
          - summary: Sample User Roles
            value: workspace_member
      type: object
      required:
      - email
      - role
      title: AddUserSupport
      description: Details of the workspace to be created
      examples:
      - first_name: John
        last_name: Smith
        email: johnsmith@gmail.com
        role: workspace_admin
    UserFieldSchema:
      properties:
        id:
          oneOf:
          - type: integer
          - type: 'null'
          title: ID
          description: ID of the user
          examples:
          - value: 2
        email:
          oneOf:
          - type: string
            format: email
            title: Email of the user
            description: Email of the customer
            examples:
            - value: test@gmail.com
          - type: 'null'
          title: Email
          description: Email of the user
          examples:
          - value: test@asfd.com
        user_name:
          oneOf:
          - type: string
          - type: 'null'
          title: Name
          description: Name of the user
          examples:
          - value: Sample User Name
        first_name:
          oneOf:
          - type: string
          - type: 'null'
          title: First name of the user
          description: First name of the user
          examples:
          - value: Sample First Name
        last_name:
          oneOf:
          - type: string
          - type: 'null'
          title: Last name of the user
          description: Sample Last Name
          examples:
          - value: Sample Last Name
        last_login_date:
          oneOf:
          - type: string
            format: date-time
          - type: 'null'
          title: Last Login of the user
          description: Last Login of the user
          examples:
          - summary: '2023-12-20T03:37:40'
            value: '2023-12-20T03:37:40'
        last_app_activity_at:
          oneOf:
          - type: string
            format: date-time
          - type: 'null'
          title: Last Active of the user
          description: Last Active of the user
          examples:
          - summary: Sample Last Active Date
            value: '2023-12-20T03:37:40'
        user_roles:
          oneOf:
          - type: object
          - type: 'null'
          title: User Roles of the user
          description: User Roles of the user
          examples:
          - summary: Sample User Roles
            value: '{}'
        last_login_from_ip:
          oneOf:
          - type: string
            format: ipv4
            description: IPv4 address
          - type: string
            format: ipv6
            description: IPv6 address
          - type: 'null'
          title: Last Login From IP of the user
          description: Last Login From IP of the user
          examples:
          - summary: Sample Login From IP
            value: 127.0.0.1
        created_at:
          oneOf:
          - type: string
            format: date-time
          - type: 'null'
          title: Created At
          description: Created At
          examples:
          - summary: Sample Date
            value: '2023-12-20T03:37:40'
        last_updated_at:
          oneOf:
          - type: string
            format: date-time
          - type: 'null'
          title: Last Updated At of the resource
          description: Last Updated At of the user
          examples:
          - summary: Sample Date
            value: '2023-12-20T03:37:40'
      type: object
      required: []
      title: UserFieldSchema
    UserPostSchema:
      properties:
        id:
          type: integer
          minimum: 0.0
          title: ID
          description: ID of the user
          examples:
          - value: 2
      type: object
      required:
      - id
      title: UserPostSchema
  securitySchemes:
    bearerAuth:
      type: http
      description: 'Primary credential. Authorization: Bearer mm_<token>. The token is issued server-side and shown once at creation.'
      scheme: bearer
    apiKey:
      type: apiKey
      description: Deprecated — use bearerAuth.
      name: X-API-KEY
      in: header
    apiSecret:
      type: apiKey
      description: Deprecated — use bearerAuth.
      name: X-API-SECRET
      in: header
    workspaceId:
      type: apiKey
      description: Required with X-API-KEY and X-API-SECRET. Deprecated with them — use bearerAuth.
      name: X-WORKSPACE-ID
      in: header
x-refined-from:
- app.mammoth.io-openapi.json
- mammoth-io-openapi.json