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/terradue-srl:terradue-srl-users-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: Invenio REST Users API
  description: '## **Summary**

    The following document is a reference guide for all the REST APIs that InvenioRDM exposes.

    ## **Resources**

    - 📚 Product documentation

    - 🔗 OpenAPI GitHub repository

    - 🌐 Invenio project

    - 💬 Community support'
  version: 12.0.3
  contact:
    name: InvenioRDM Documentation
    url: https://inveniordm.docs.cern.ch
  license:
    name: MIT License
    url: https://opensource.org/licenses/MIT
  x-copyright: KTH Royal Institute of Technology 2025
  x-repo: https://github.com/Samk13/invenio-api-toolkit
servers:
- url: '{baseURL}'
  description: InvenioRDM instance
  variables:
    baseURL:
      default: https://inveniordm.web.cern.ch
      description: Base URL of your InvenioRDM instance
security:
- BearerAuth: []
tags:
- name: Users
  description: User management endpoints
paths:
  /api/users:
    get:
      summary: Get a user by ID
      tags:
      - Users
      operationId: getAUserById
      parameters: []
      responses:
        '200':
          $ref: '#/components/responses/Success'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '500':
          $ref: '#/components/responses/InternalServerError'
      security:
      - BearerAuth: []
  /api/user/communities:
    get:
      summary: Search User Communities
      tags:
      - Users
      operationId: searchUserCommunities
      parameters:
      - name: page
        in: query
        required: false
        schema:
          type: string
        example: '1'
      - name: type
        in: query
        required: false
        schema:
          type: string
        example: project
      - name: size
        in: query
        required: false
        schema:
          type: string
        example: '1'
      - name: sort
        in: query
        required: false
        schema:
          type: string
        example: oldest
      responses:
        '200':
          $ref: '#/components/responses/Success'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '500':
          $ref: '#/components/responses/InternalServerError'
      security:
      - BearerAuth: []
  /api/user/records:
    get:
      summary: Get all draft records
      tags:
      - Users
      operationId: getAllDraftRecords
      parameters:
      - name: q
        in: query
        required: false
        schema:
          type: string
        example: is_published:false
      - name: search
        in: query
        required: false
        schema:
          type: string
        description: Search query used to filter user records, typically by persistent identifier or other record fields.
        example: pids.doi.identifier:example-doi-123
      responses:
        '200':
          $ref: '#/components/responses/Success'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '500':
          $ref: '#/components/responses/InternalServerError'
      security:
      - BearerAuth: []
  /api/users/{userId}:
    get:
      summary: Get a user by ID
      tags:
      - Users
      operationId: getUserByIdDetailed
      parameters:
      - name: userId
        in: path
        required: true
        schema:
          type: string
        description: Unique identifier for the user
      responses:
        '200':
          $ref: '#/components/responses/Success'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '500':
          $ref: '#/components/responses/InternalServerError'
      security:
      - BearerAuth: []
  /api/users/{userId}/avatar.svg:
    get:
      summary: Get avatar for user
      tags:
      - Users
      operationId: getAvatarForUser
      parameters:
      - name: userId
        in: path
        required: true
        schema:
          type: string
        description: Unique identifier for the user
      responses:
        '200':
          $ref: '#/components/responses/Success'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '500':
          $ref: '#/components/responses/InternalServerError'
      security:
      - BearerAuth: []
components:
  responses:
    Forbidden:
      description: Forbidden - Insufficient permissions
    Unauthorized:
      description: Unauthorized - Authentication required
    Success:
      description: Successful response
      content:
        application/json:
          schema:
            type: object
    InternalServerError:
      description: Internal server error - Unexpected server error
    BadRequest:
      description: Bad request - Invalid input parameters
    NotFound:
      description: Not found - Resource does not exist
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      description: Bearer token authentication