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-tool-claims-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 Tool claims API
  version: 0.1.0
  contact:
    name: Mammoth Analytics
    url: https://mammoth.io
    email: support@mammoth.io
  description: 'Operations tagged Tool claims 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: Tool claims
paths:
  /tool-claims:
    get:
      tags:
      - Tool claims
      summary: What an Open tables link opens
      description: Public. Says what the emailed link stands for and, for a signed-in caller, whether it was sent to them. Never returns the address.
      operationId: GetToolClaim
      parameters:
      - name: token
        in: query
        schema:
          type: string
        required: true
        deprecated: false
        allowEmptyValue: false
        allowReserved: false
      responses:
        '200':
          description: What the link opens
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ToolClaimStatus'
        '400':
          description: Bad request syntax or unsupported method
          content:
            application/json:
              schema:
                oneOf:
                - properties:
                    status_code:
                      type: integer
                    detail:
                      type: string
                    extra:
                      additionalProperties: {}
                      type:
                      - 'null'
                      - object
                      - array
                  type: object
                  required:
                  - detail
                  - status_code
                  description: Client Error
                  examples:
                  - status_code: 400
                    detail: Bad Request
                    extra: {}
                - 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: {}
        '404':
          description: Unknown link
      deprecated: false
    post:
      tags:
      - Tool claims
      summary: Open an Open tables link without being signed in
      description: Public. For an address with no account, creates the account, adds the tables and returns a one-time sign-in link. Otherwise says to sign in.
      operationId: StartToolClaim
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ToolClaimTokenInput'
        required: true
      responses:
        '200':
          description: How the visitor continues
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ToolClaimStart'
        '400':
          description: Bad request syntax or unsupported method
          content:
            application/json:
              schema:
                oneOf:
                - properties:
                    status_code:
                      type: integer
                    detail:
                      type: string
                    extra:
                      additionalProperties: {}
                      type:
                      - 'null'
                      - object
                      - array
                  type: object
                  required:
                  - detail
                  - status_code
                  description: Client Error
                  examples:
                  - status_code: 400
                    detail: Bad Request
                    extra: {}
                - 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: {}
        '404':
          description: Unknown link
        '410':
          description: The link has expired
      deprecated: false
    servers:
    - url: /api/v2
  /workspaces/{workspace_id}/projects/{project_id}/tool-claims:
    post:
      tags:
      - Tool claims
      summary: Add an Open tables link's tables to a project
      description: Adds the tables to a new folder in the project. Redeeming the same link again returns where they already are and adds nothing.
      operationId: RedeemToolClaim
      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: project_id
        in: path
        schema:
          type: integer
          minimum: 1.0
          title: Project ID
          description: Project ID of the workspace
          examples:
          - 4
        description: Project ID of the workspace
        required: true
        deprecated: false
        examples:
          project_id-example-1:
            summary: Sample project ID
            value: 4
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ToolClaimTokenInput'
        required: true
      responses:
        '200':
          description: Where the tables were added
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ToolClaimTarget'
        '400':
          description: Bad request syntax or unsupported method
          content:
            application/json:
              schema:
                oneOf:
                - properties:
                    status_code:
                      type: integer
                    detail:
                      type: string
                    extra:
                      additionalProperties: {}
                      type:
                      - 'null'
                      - object
                      - array
                  type: object
                  required:
                  - detail
                  - status_code
                  description: Client Error
                  examples:
                  - status_code: 400
                    detail: Bad Request
                    extra: {}
                - 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: {}
        '403':
          description: The link was sent to another address
        '404':
          description: Unknown link
        '410':
          description: The link has expired
      deprecated: false
    servers:
    - url: /api/v2
components:
  schemas:
    ToolClaimStatus:
      properties:
        file_name:
          type: string
          description: Name of the file the tables came from
        table_count:
          type: integer
          description: How many tables the link opens
        expired:
          type: boolean
          description: Whether the link is past its lifetime
        signed_in:
          type: boolean
          description: Whether the request carried a session
        for_this_account:
          type: boolean
          description: Whether the link was sent to the signed-in user's address
        redeemed:
          oneOf:
          - $ref: '#/components/schemas/ToolClaimTarget'
          - type: 'null'
          description: Where the tables are, once added. Only shown to the claim's owner.
      type: object
      required:
      - expired
      - file_name
      - for_this_account
      - signed_in
      - table_count
      title: ToolClaimStatus
    ToolClaimStart:
      properties:
        state:
          type: string
          enum:
          - created
          - sign_in
          description: 'created: an account was made, follow login_url. sign_in: sign in normally, then redeem.'
        login_url:
          oneOf:
          - type: string
          - type: 'null'
          description: One-time sign-in link, when state is created
      type: object
      required:
      - state
      title: ToolClaimStart
    ToolClaimTarget:
      properties:
        workspace_id:
          type: integer
          description: Workspace the tables were added to
        project_id:
          type: integer
          description: Project the tables were added to
        folder_id:
          oneOf:
          - type: integer
          - type: 'null'
          description: Resource id of the folder holding the tables
      type: object
      required:
      - project_id
      - workspace_id
      title: ToolClaimTarget
    ToolClaimTokenInput:
      properties:
        token:
          type: string
          maxLength: 300
          description: Token from the emailed link
      type: object
      required:
      - token
      title: ToolClaimTokenInput
      description: The emailed link's token
  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