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/broad-institute:broad-institute-users-api"

All apis

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

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

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: Terra Users API
  description: Terra API
  termsOfService: https://app.terra.bio/#terms-of-service
  license:
    name: BSD
    url: http://opensource.org/licenses/BSD-3-Clause
  version: '0.1'
servers:
- url: /
security:
- oidc: []
tags:
- name: Users
paths:
  /api/users/v1/registerWithProfile:
    post:
      tags:
      - Users
      summary: Registers the user in Sam and saves the user profile in Thurloe
      operationId: registerUserWithProfile
      requestBody:
        description: A registration request
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RegisterRequest'
        required: false
      responses:
        200:
          description: OK
          content: {}
        400:
          description: Bad request
          content: {}
        403:
          description: Forbidden
          content: {}
        500:
          description: Internal server error
          content: {}
      x-passthrough: false
      x-codegen-request-body-name: profile
components:
  schemas:
    RegisterRequest:
      type: object
      properties:
        acceptsTermsOfService:
          type: boolean
          description: Does the user accept the Terra Terms of Service?
        profile:
          $ref: '#/components/schemas/Profile'
    Profile:
      required:
      - firstName
      - institute
      - institutionalProgram
      - lastName
      - nonProfitStatus
      - pi
      - programLocationCity
      - programLocationCountry
      - programLocationState
      - title
      type: object
      properties:
        firstName:
          type: string
          description: User's first name
        lastName:
          type: string
          description: User's last name
        title:
          type: string
          description: User's title
        contactEmail:
          type: string
          description: User's contact email (if different from account email)
        institute:
          type: string
          description: User's home institution
        institutionalProgram:
          type: string
          description: User's institutional program
        programLocationCity:
          type: string
          description: User's program location city
        programLocationState:
          type: string
          description: User's program location state
        programLocationCountry:
          type: string
          description: User's program location country
        pi:
          type: string
          description: Principal Investigator
        nonProfitStatus:
          type: string
          description: User's program non-profit status
        termsOfService:
          type: string
          description: The Terms of Service url, "app.terra.bio/#terms-of-service", which a user must include to show they accept the Terms of Service
        department:
          type: string
          description: User's department within an institution
        interestInTerra:
          type: string
          description: A string of comma-separated values of why the User is interested in Terra
  securitySchemes:
    oidc:
      type: oauth2
      x-tokenName: id_token
      flows:
        authorizationCode:
          authorizationUrl: OAUTH_AUTHORIZATION_URL
          scopes: {}
          tokenUrl: OAUTH_TOKEN_URL
    oidc_google_billing_scope:
      type: oauth2
      x-tokenName: id_token
      flows:
        authorizationCode:
          authorizationUrl: OAUTH_AUTHORIZATION_URL_WITH_GOOGLE_BILLING_SCOPE
          scopes: {}
          tokenUrl: OAUTH_TOKEN_URL_WITH_GOOGLE_BILLING_SCOPE