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-client-apps-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 Client Apps API
  version: 0.1.0
  contact:
    name: Mammoth Analytics
    url: https://mammoth.io
    email: support@mammoth.io
  description: 'Operations tagged Client Apps 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: Client Apps
paths:
  /workspaces/{workspace_id}/clientapps/{client_key}:
    get:
      tags:
      - Client Apps
      summary: Get client app details
      operationId: AppDetails
      parameters:
      - name: workspace_id
        in: path
        schema:
          type: integer
          minimum: 1.0
          title: Workspace ID
          description: Workspace refers to a collection of projects. Workspace ID is unique identifier for workspace.
          examples:
          - 4
        description: Workspace refers to a collection of projects. Workspace ID is unique identifier for workspace.
        required: true
        deprecated: false
        examples:
          workspace_id-example-1:
            summary: Sample workspace ID
            value: 4
      - name: client_key
        in: path
        schema:
          type: string
          maxLength: 200
          minLength: 16
          title: Client Key
          description: Id of the client key to work with
          examples:
          - abcdefasdfafdsfaf345asf
        description: Id of the client key to work with
        required: true
        deprecated: false
        examples:
          client_key-example-1:
            summary: Sample client key ID
            value: abcdefasdfafdsfaf345asf
      - name: fields
        in: query
        schema:
          type: string
          title: Fields
          description: Fields to return. Can be (id, app_name)
          default: __standard
          examples:
          - id,app_name
        description: Fields to return. Can be (id, app_name)
        required: false
        deprecated: false
        allowEmptyValue: false
        allowReserved: false
        examples:
          fields-example-1:
            summary: Return only id and app_name in the result
            value: id,app_name
      responses:
        '200':
          description: Get client app details
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ClientAppSchema'
        '400':
          description: Bad Request
        '403':
          description: Request forbidden -- authorization will not help
          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: Authorization Exception
                examples:
                - status_code: 403
                  detail: Forbidden
                  extra: {}
        '401':
          description: Authorization error
      deprecated: false
    delete:
      tags:
      - Client Apps
      summary: Delete a client app
      operationId: DeleteApp
      parameters:
      - name: workspace_id
        in: path
        schema:
          type: integer
          minimum: 1.0
          title: Workspace ID
          description: Workspace refers to a collection of projects. Workspace ID is unique identifier for workspace.
          examples:
          - 4
        description: Workspace refers to a collection of projects. Workspace ID is unique identifier for workspace.
        required: true
        deprecated: false
        examples:
          workspace_id-example-1:
            summary: Sample workspace ID
            value: 4
      - name: client_key
        in: path
        schema:
          type: string
          maxLength: 200
          minLength: 16
          title: Client Key
          description: Id of the client key to work with
          examples:
          - abcdefasdfafdsfaf345asf
        description: Id of the client key to work with
        required: true
        deprecated: false
        examples:
          client_key-example-1:
            summary: Sample client key ID
            value: abcdefasdfafdsfaf345asf
      responses:
        '204':
          description: Request fulfilled, nothing follows
          headers: {}
        '400':
          description: Bad Request
        '403':
          description: Request forbidden -- authorization will not help
          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: Authorization Exception
                examples:
                - status_code: 403
                  detail: Forbidden
                  extra: {}
        '200':
          description: Successful delete
        '401':
          description: Authorization error
      deprecated: false
    patch:
      tags:
      - Client Apps
      summary: Update client app
      description: Update client app details like name, description, secret etc
      operationId: UpdateApp
      parameters:
      - name: workspace_id
        in: path
        schema:
          type: integer
          minimum: 1.0
          title: Workspace ID
          description: Workspace refers to a collection of projects. Workspace ID is unique identifier for workspace.
          examples:
          - 4
        description: Workspace refers to a collection of projects. Workspace ID is unique identifier for workspace.
        required: true
        deprecated: false
        examples:
          workspace_id-example-1:
            summary: Sample workspace ID
            value: 4
      - name: client_key
        in: path
        schema:
          type: string
          maxLength: 200
          minLength: 16
          title: Client Key
          description: Id of the client key to work with
          examples:
          - abcdefasdfafdsfaf345asf
        description: Id of the client key to work with
        required: true
        deprecated: false
        examples:
          client_key-example-1:
            summary: Sample client key ID
            value: abcdefasdfafdsfaf345asf
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PatchRequest'
        required: true
      responses:
        '200':
          description: Successful patch
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ClientAppSchema'
        '400':
          description: Bad Request
        '403':
          description: Request forbidden -- authorization will not help
          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: Authorization Exception
                examples:
                - status_code: 403
                  detail: Forbidden
                  extra: {}
        '401':
          description: Authorization error
      deprecated: false
    servers:
    - url: /api/v2
  /workspaces/{workspace_id}/clientapps:
    get:
      tags:
      - Client Apps
      summary: Get list of client apps
      description: Get list of client apps specific to given user and workspace
      operationId: ListApps
      parameters:
      - name: workspace_id
        in: path
        schema:
          type: integer
          minimum: 1.0
          title: Workspace ID
          description: Workspace refers to a collection of projects. Workspace ID is unique identifier for workspace.
          examples:
          - 4
        description: Workspace refers to a collection of projects. Workspace ID is unique identifier for workspace.
        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, app_name)
          default: __standard
          examples:
          - id,app_name
        description: Fields to return. Can be (id, app_name)
        required: false
        deprecated: false
        allowEmptyValue: false
        allowReserved: false
        examples:
          fields-example-1:
            summary: Return only id and app_name in the result
            value: id,app_name
      - name: sort
        in: query
        schema:
          oneOf:
          - type: string
          - type: 'null'
          title: Order by column name
          description: Returned client apps based on this parameter Use the format '(field:asc)' for ascending and '(field:desc)' for descending order.
          examples:
          - (last_usage:asc),(id:desc)
        description: Returned client apps based on this parameter Use the 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 client_apps.id in descending order
            value: (last_usage:asc),(id:desc)
      responses:
        '200':
          description: List of client apps
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ClientAppsList'
        '400':
          description: Bad Request
        '403':
          description: Request forbidden -- authorization will not help
          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: Authorization Exception
                examples:
                - status_code: 403
                  detail: Forbidden
                  extra: {}
        '401':
          description: Authorization error
      deprecated: false
    post:
      tags:
      - Client Apps
      summary: Create api tokens to access api
      description: Create api tokens to a user for a workspace to access APIs
      operationId: CreateApp
      parameters:
      - name: workspace_id
        in: path
        schema:
          type: integer
          minimum: 1.0
          title: Workspace ID
          description: Workspace refers to a collection of projects. Workspace ID is unique identifier for workspace.
          examples:
          - 4
        description: Workspace refers to a collection of projects. Workspace ID is unique identifier for workspace.
        required: true
        deprecated: false
        examples:
          workspace_id-example-1:
            summary: Sample workspace ID
            value: 4
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ClientAppCreate'
        required: true
      responses:
        '201':
          description: Successful create
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ClientAppPostResponse'
        '400':
          description: Bad Request
        '403':
          description: Request forbidden -- authorization will not help
          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: Authorization Exception
                examples:
                - status_code: 403
                  detail: Forbidden
                  extra: {}
        '401':
          description: Authorization error
      deprecated: false
    servers:
    - url: /api/v2
components:
  schemas:
    ClientAppSchema:
      properties:
        description:
          oneOf:
          - type: string
          - type: 'null'
          description: Description of client app or api tokens
          examples:
          - value: Example Client App Description
        workspace_id:
          oneOf:
          - type: integer
          - type: 'null'
          description: Workspace ID of client app or api tokens
          examples:
          - value: 1
        user_id:
          oneOf:
          - type: integer
          - type: 'null'
          description: User ID of client app or api tokens
          examples:
          - value: 1
        last_usage:
          oneOf:
          - type: string
            format: date-time
          - type: 'null'
          description: Last usage of client app or api tokens
          examples:
          - value: '2021-09-28T11:30:00.000Z'
        created_at:
          oneOf:
          - type: string
            format: date-time
          - type: 'null'
          description: Creation time of client app or api tokens. Null for apps created before this was recorded.
          examples:
          - value: '2021-09-28T11:30:00.000Z'
        id:
          type: integer
          exclusiveMinimum: 0.0
          description: ID of client app or api tokens
          examples:
          - value: 1
        app_name:
          type: string
          description: Name of client app or api tokens
          examples:
          - value: Example Client App Name
        app_key:
          type: string
          description: App key of client app or api tokens
          examples:
          - value: mm_a1b2c3d4e5f6a1b2
      type: object
      required:
      - app_key
      - app_name
      - id
      title: ClientAppSchema
    PatchRequest:
      properties:
        patch:
          items:
            $ref: '#/components/schemas/PatchOperation'
          type: array
      type: object
      required:
      - patch
      title: PatchRequest
      description: Details of the app to be created
      examples:
      - patch:
        - op: replace
          path: app_name
          value: test
        - op: replace
          path: description
          value: test
    ClientAppsList:
      properties:
        result:
          items:
            oneOf:
            - $ref: '#/components/schemas/ClientAppSchema'
            - $ref: '#/components/schemas/ClientAppMinSchema'
            - $ref: '#/components/schemas/ClientAppStdSchema'
            - $ref: '#/components/schemas/ClientAppFullSchema'
            - $ref: '#/components/schemas/ClientAppFieldsSchema'
          type: array
      type: object
      required:
      - result
      title: ClientAppsList
    ClientAppType:
      type: string
      enum:
      - legacy
      - token
      title: ClientAppType
      description: Which credential this app authenticates with — 'legacy' for the X-API-KEY/X-API-SECRET pair or 'token' for a single Bearer token. app_key is only a usable credential (paired with the secret) for a legacy app — for a token app it is a display id only.
      examples:
      - value: token
    ClientAppFullSchema:
      properties:
        id:
          type: integer
          exclusiveMinimum: 0.0
          description: ID of client app or api tokens
          examples:
          - value: 1
        app_name:
          type: string
          description: Name of client app or api tokens
          examples:
          - value: Example Client App Name
        app_key:
          type: string
          description: App key of client app or api tokens
          examples:
          - value: mm_a1b2c3d4e5f6a1b2
        type:
          $ref: '#/components/schemas/ClientAppType'
        description:
          oneOf:
          - type: string
          - type: 'null'
          description: Description of client app or api tokens
          examples:
          - value: Example Client App Description
        workspace_id:
          type: integer
          exclusiveMinimum: 0.0
          description: Workspace ID of client app or api tokens
          examples:
          - value: 1
        user_id:
          type: integer
          exclusiveMinimum: 0.0
          description: User ID of client app or api tokens
          examples:
          - value: 1
        project_id:
          oneOf:
          - type: integer
          - type: 'null'
          description: Project ID of client app or api tokens
          examples:
          - value: 1
        last_usage:
          oneOf:
          - type: string
            format: date-time
          - type: 'null'
          description: Last usage of client app or api tokens
          examples:
          - value: '2021-09-28T11:30:00.000Z'
        created_at:
          oneOf:
          - type: string
            format: date-time
          - type: 'null'
          description: Creation time of client app or api tokens. Null for apps created before this was recorded.
          examples:
          - value: '2021-09-28T11:30:00.000Z'
      type: object
      required:
      - app_key
      - app_name
      - id
      - type
      - user_id
      - workspace_id
      title: ClientAppFullSchema
    ClientAppFieldsSchema:
      properties:
        description:
          oneOf:
          - type: string
          - type: 'null'
          description: Description of client app or api tokens
          examples:
          - value: Example Client App Description
        workspace_id:
          oneOf:
          - type: integer
          - type: 'null'
          description: Workspace ID of client app or api tokens
          examples:
          - value: 1
        user_id:
          oneOf:
          - type: integer
          - type: 'null'
          description: User ID of client app or api tokens
          examples:
          - value: 1
        last_usage:
          oneOf:
          - type: string
            format: date-time
          - type: 'null'
          description: Last usage of client app or api tokens
          examples:
          - value: '2021-09-28T11:30:00.000Z'
        created_at:
          oneOf:
          - type: string
            format: date-time
          - type: 'null'
          description: Creation time of client app or api tokens. Null for apps created before this was recorded.
          examples:
          - value: '2021-09-28T11:30:00.000Z'
        id:
          oneOf:
          - type: integer
          - type: 'null'
          description: ID of client app or api tokens
          examples:
          - value: 1
        app_name:
          oneOf:
          - type: string
          - type: 'null'
          description: Name of client app or api tokens
          examples:
          - value: Example Client App Name
        app_key:
          oneOf:
          - type: string
          - type: 'null'
          description: App key of client app or api tokens
          examples:
          - value: mm_a1b2c3d4e5f6a1b2
        type:
          oneOf:
          - $ref: '#/components/schemas/ClientAppType'
          - type: 'null'
          description: Which credential this app authenticates with — 'legacy' for the X-API-KEY/X-API-SECRET pair or 'token' for a single Bearer token. app_key is only a usable credential (paired with the secret) for a legacy app — for a token app it is a display id only.
          examples:
          - value: token
      type: object
      required: []
      title: ClientAppFieldsSchema
    ClientAppPostResponse:
      properties:
        app_name:
          type: string
          description: Name of client app or api tokens
          examples:
          - value: Example Client App Name
        app_key:
          type: string
          description: App key of client app or api tokens
          examples:
          - value: mm_a1b2c3d4e5f6a1b2
        description:
          type: string
          description: Description of client app or api tokens
          examples:
          - value: Example Client App Description
        workspace_id:
          type: integer
          exclusiveMinimum: 0.0
          description: Workspace ID of client app or api tokens
          examples:
          - value: 1
        user_id:
          type: integer
          exclusiveMinimum: 0.0
          description: User ID of client app or api tokens
          examples:
          - value: 1
        token:
          type: string
          description: The plaintext Bearer token. Returned exactly once — it is never recoverable after this response.
          examples:
          - value: mm_abcDefGhiJklMnoPqrStuVwxYz1234567890abcDefGhiJklMnoPqr
        expires_at:
          oneOf:
          - type: string
            format: date-time
          - type: 'null'
          description: When the token stops working (UTC). Null = it never expires. Set on a token the Mammoth CLI creates.
      type: object
      required:
      - app_key
      - app_name
      - description
      - token
      - user_id
      - workspace_id
      title: ClientAppPostResponse
    ClientAppStdSchema:
      properties:
        id:
          type: integer
          exclusiveMinimum: 0.0
          description: ID of client app or api tokens
          examples:
          - value: 1
        app_name:
          type: string
          description: Name of client app or api tokens
          examples:
          - value: Example Client App Name
        app_key:
          type: string
          description: App key of client app or api tokens
          examples:
          - value: mm_a1b2c3d4e5f6a1b2
        type:
          $ref: '#/components/schemas/ClientAppType'
        description:
          oneOf:
          - type: string
          - type: 'null'
          description: Description of client app or api tokens
          examples:
          - value: Example Client App Description
        workspace_id:
          type: integer
          exclusiveMinimum: 0.0
          description: Workspace ID of client app or api tokens
          examples:
          - value: 1
        user_id:
          type: integer
          exclusiveMinimum: 0.0
          description: User ID of client app or api tokens
          examples:
          - value: 1
        project_id:
          oneOf:
          - type: integer
          - type: 'null'
          description: Project ID of client app or api tokens
          examples:
          - value: 1
        last_usage:
          oneOf:
          - type: string
            format: date-time
          - type: 'null'
          description: Last usage of client app or api tokens
          examples:
          - value: '2021-09-28T11:30:00.000Z'
        created_at:
          oneOf:
          - type: string
            format: date-time
          - type: 'null'
          description: Creation time of client app or api tokens. Null for apps created before this was recorded.
          examples:
          - value: '2021-09-28T11:30:00.000Z'
      type: object
      required:
      - app_key
      - app_name
      - id
      - type
      - user_id
      - workspace_id
      title: ClientAppStdSchema
    PatchOperation:
      properties:
        op:
          type: string
          const: replace
          maxLength: 50
          minLength: 1
          description: Operation
          examples:
          - value: replace
        path:
          type: string
          enum:
          - app_name
          - description
          - project_id
          description: Path
          examples:
          - value: app_name
        value:
          oneOf:
          - type: string
          - items:
              type: string
            type: array
          description: Value to replace the attribute with
          examples:
          - value: New name
      type: object
      required:
      - op
      - path
      - value
      title: PatchOperation
    ClientAppCreate:
      properties:
        app_name:
          type: string
          maxLength: 100
          minLength: 1
          description: Name of client app or api tokens
          examples:
          - value: New Example Client App Name
        description:
          type: string
          description: Description of client app or api tokens
          examples:
          - value: Example Client App Description
        project_id:
          oneOf:
          - type: integer
          - type: 'null'
          description: Project ID
          examples:
          - value: Sample project ID
      type: object
      required:
      - app_name
      - description
      title: ClientAppCreate
      description: Details of the app to be created
      examples:
      - app_name: test2
        description: test from doc
    ClientAppMinSchema:
      properties:
        id:
          type: integer
          exclusiveMinimum: 0.0
          description: ID of client app or api tokens
          examples:
          - value: 1
        app_name:
          type: string
          description: Name of client app or api tokens
          examples:
          - value: Example Client App Name
        app_key:
          type: string
          description: App key of client app or api tokens
          examples:
          - value: mm_a1b2c3d4e5f6a1b2
        type:
          $ref: '#/components/schemas/ClientAppType'
      type: object
      required:
      - app_key
      - app_name
      - id
      - type
      title: ClientAppMinSchema
  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