Ghent University

Ghent University Library People Service

An OpenAPI 3.1 contract authored and open-sourced by Ghent University Library for the people and organizations directory behind the Academic Bibliography. Sixteen operations covering person and organization records, identifier lookup, suggest, role and settings management, and an explicit set-person-orcid operation that makes ORCID a first-class field. servers[] is relative (/api/v1) because the service runs inside the university's own estate - no public base URL is published and none has been invented here. Authentication is an X-Api-Key header.

GitHub OpenAPI

Operations 16

POST /add-person Insert/update a single person record #
POST /get-person Retrieve a single person record #
POST /get-people-by-identifier Retrieve person records by one of the extra identifiers #
POST /get-people-by-id Retrieve person records by their ids #
POST /get-people Get all person records #
POST /suggest-people Search on person records #
POST /set-person-orcid Update person ORCID #
POST /set-person-token Update person tokens #
POST /set-person-role Update person role #
POST /set-person-settings Update person settings #
POST /add-organization Insert/update a single organization record #
POST /get-organization Get single organization record #
POST /get-organizations-by-identifier Get organization records by one of the extra identifiers #
POST /get-organizations-by-id Get organization records by their ids #
POST /get-organizations Get all organization records #
POST /suggest-organizations Search on organization records #

Documentation

📖
APIReference
https://raw.githubusercontent.com/ugent-library/people-service/main/api/v1/openapi.yaml
📖
Authentication
https://raw.githubusercontent.com/api-evangelist/ghent/refs/heads/main/authentication/ghent-authentication.yml

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/ghent/refs/heads/main/openapi/ghent-people-service-openapi.yaml

Other Resources

🔗
SourceCode
https://github.com/ugent-library/people-service
🔗
Errors
https://raw.githubusercontent.com/api-evangelist/ghent/refs/heads/main/errors/ghent-errors.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • 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/people-service"
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

ghent-people-service-openapi.yaml Raw ↑ 
# Provenance
#   generated: '2026-09-01'
#   method: searched
#   source: https://raw.githubusercontent.com/ugent-library/people-service/main/api/v1/openapi.yaml
#   x-operator: institution
#   note: Authored and published by Ghent University Library (github.com/ugent-library,
#     "Library applications built for libraries at Ghent University"). servers[] is
#     relative (/api/v1) because the service is deployed inside the university's own
#     estate; no public base URL is published, and none has been invented here.
#     Verbatim upstream copy is in openapi/_original/ghent-people-service-openapi.yaml.
openapi: 3.1.0

info:
  title: People Service
  version: 0.0.1

servers:
  - url: /api/v1

paths:
  "/add-person":
    post:
      summary: "Insert/update a single person record"
      description: "Insert/update a single person record"
      operationId: "AddPerson"
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/AddPersonRequest"
        required: true
      responses:
        "200":
          description: "Created/updated single person record successfully"
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Person"
        default:
          $ref: "#/components/responses/Error"


  "/get-person":
    post:
      summary: "Retrieve a single person record"
      description: "Retrieve a single person record"
      operationId: "GetPerson"
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/GetPersonRequest"
        required: true
      responses:
        "200":
          description: "Retrieve single person record successfully"
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Person"
        default:
          $ref: "#/components/responses/Error"

  "/get-people-by-identifier":
    post:
      summary: "Retrieve person records by one of the extra identifiers"
      description: "Retrieve person records by one of the extra identifiers"
      operationId: "GetPeopleByIdentifier"
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/GetPeopleByIdentifierRequest"
        required: true
      responses:
        "200":
          description: "Retrieve single person record successfully"
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/PersonListResponse"
        default:
          $ref: "#/components/responses/Error"

  "/get-people-by-id":
    post:
      summary: "Retrieve person records by their ids"
      description: "Retrieve person records by their ids"
      operationId: "GetPeopleById"
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/GetPeopleByIdRequest"
        required: true
      responses:
        "200":
          description: "Retrieve single person record successfully"
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/PersonListResponse"
        default:
          $ref: "#/components/responses/Error"


  "/get-people":
    post:
      summary: "Get all person records"
      description: "Get all person records"
      operationId: "GetPeople"
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/GetPeopleRequest"
        required: true
      responses:
        "200":
          description: "Success"
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/PersonPagedListResponse"
        default:
          $ref: "#/components/responses/Error"

  "/suggest-people":
    post:
      summary: "Search on person records"
      description: "Search on person records"
      operationId: "SuggestPeople"
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/SuggestPeopleRequest"
        required: true
      responses:
        "200":
          description: "Success"
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/PersonListResponse"
        default:
          $ref: "#/components/responses/Error"  

  "/set-person-orcid":
    post:
      summary: "Update person ORCID"
      description: "Update person ORCID"
      operationId: "SetPersonOrcid"
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/SetPersonOrcidRequest"
        required: true
      responses:
        "200":
          description: "Success"
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Person"
        default:
          $ref: "#/components/responses/Error"

  "/set-person-token":
    post:
      summary: "Update person tokens"
      description: "Update person tokens"
      operationId: "SetPersonToken"
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/SetPersonTokenRequest"
        required: true
      responses:
        "200":
          description: "Success"
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Person"
        default:
          $ref: "#/components/responses/Error"

  "/set-person-role":
    post:
      summary: "Update person role"
      description: "Update person role"
      operationId: "SetPersonRole"
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/SetPersonRoleRequest"
        required: true
      responses:
        "200":
          description: "Success"
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Person"
        default:
          $ref: "#/components/responses/Error"

  "/set-person-settings":
    post:
      summary: "Update person settings"
      description: "Update person settings"
      operationId: "SetPersonSettings"
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/SetPersonSettingsRequest"
        required: true
      responses:
        "200":
          description: "Success"
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Person"
        default:
          $ref: "#/components/responses/Error"

  "/add-organization":
    post:
      summary: "Insert/update a single organization record"
      description: "Insert/update a single organization record"
      operationId: "AddOrganization"
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/AddOrganizationRequest"
        required: true
      responses:
        "200":
          description: "Created/updated single organization record successfully"
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Organization"
        default:
          $ref: "#/components/responses/Error"

  "/get-organization":
    post:
      summary: "Get single organization record"
      description: "Get single organization record"
      operationId: "GetOrganization"
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/GetOrganizationRequest"
        required: true
      responses:
        "200":
          description: "Retrieve a single organization record successfully"
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Organization"
        default:
          $ref: "#/components/responses/Error"

  "/get-organizations-by-identifier":
    post:
      summary: "Get organization records by one of the extra identifiers"
      description: "Get organization records by one of the extra identifiers"
      operationId: "GetOrganizationsByIdentifier"
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/GetOrganizationsByIdentifierRequest"
        required: true
      responses:
        "200":
          description: "Retrieve a organization records successfully"
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/OrganizationListResponse"
        default:
          $ref: "#/components/responses/Error"

  "/get-organizations-by-id":
    post:
      summary: "Get organization records by their ids"
      description: "Get organization records by their ids"
      operationId: "GetOrganizationsById"
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/GetOrganizationsByIdRequest"
        required: true
      responses:
        "200":
          description: "Retrieve a organization records successfully"
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/OrganizationListResponse"
        default:
          $ref: "#/components/responses/Error"

  "/get-organizations":
    post:
      summary: "Get all organization records"
      description: "Get all organization records"
      operationId: "GetOrganizations"
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/GetOrganizationsRequest"
        required: true
      responses:
        "200":
          description: "Success"
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/OrganizationPagedListResponse"
        default:
          $ref: "#/components/responses/Error"

  "/suggest-organizations":
    post:
      summary: "Search on organization records"
      description: "Search on organization records"
      operationId: "SuggestOrganizations"
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/SuggestOrganizationsRequest"
        required: true
      responses:
        "200":
          description: "Success"
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/OrganizationListResponse"
        default:
          $ref: "#/components/responses/Error"

security:
  - apiKey: []

components:

  securitySchemes:
    apiKey:
      type: apiKey
      in: header
      name: X-Api-Key

  responses:
    Error:
      description: Error
      content:
        application/json:
          schema:
            $ref: "#/components/schemas/Error"

  schemas:
    Error:
      type: object
      properties:
        code:
          type: integer
          format: int64
        message:
          type: string
      required:
        - code
        - message

    StringMap:
      type: object
      additionalProperties:
        type: string

    OrganizationMember:
      type: object
      properties:
        id:
          type: string
        date_created:
          type: string
          format: date-time
        date_updated:
          type: string
          format: date-time
      required: [id]

    Person:
      type: object
      properties:
        id:
          type: string
        active:
          type: boolean
        date_created:
          type: string
          format: date-time
        date_updated:
          type: string
          format: date-time
        name:
          type: string
        given_name:
          type: string
        family_name:
          type: string
        email:
          type: string
        token:
          $ref: "#/components/schemas/StringMap"
        preferred_given_name:
          type: string
        preferred_family_name:
          type: string
        birth_date:
          type: string
        honorific_prefix:
          type: string
        identifier:
          type: array
          items:
            type: string
        organization:
          type: array
          items:
            $ref: "#/components/schemas/OrganizationMember"
        job_category:
          type: array
          items:
            type: string
        role:
          type: array
          items:
            type: string
        settings:
          type: object
          additionalProperties:
            type: string
        object_class:
          type: array
          items:
            type: string

    OrganizationParent:
      type: object
      properties:
        id:
          type: string
        date_created:
          type: string
          format: date-time
        date_updated:
          type: string
          format: date-time
        from:
          type: string
          format: date-time
        until:
          type: string
          format: date-time
      required: [id, from]

    Organization:
      type: object
      properties:
        id:
          type: string
        date_created:
          type: string
          format: date-time
        date_updated:
          type: string
          format: date-time
        type:
          type: string
        acronym:
          type: string
        name_dut:
          type: string
        name_eng:
          type: string
        parent:
          type: array
          items:
            $ref: "#/components/schemas/OrganizationParent"
        identifier:
          type: array
          items:
            type: string

    PersonListResponse:
      type: object
      required: [data]
      properties:
        data:
          type: array
          items:
            $ref: "#/components/schemas/Person"

    PersonPagedListResponse:
      type: object
      required: [data]
      properties:
        cursor:
          type: string
        data:
          type: array
          items:
            $ref: "#/components/schemas/Person"

    OrganizationListResponse:
      type: object
      required: [data]
      properties:
        data:
          type: array
          items:
            $ref: "#/components/schemas/Organization"

    OrganizationPagedListResponse:
      type: object
      required: [data]
      properties:
        cursor:
          type: string
        data:
          type: array
          items:
            $ref: "#/components/schemas/Organization"

    GetPersonRequest:
      type: object
      properties:
        id:
          type: string
          minLength: 1
      required: [id]

    AddPersonRequest:
      $ref: "#/components/schemas/Person"

    AddOrganizationRequest:
      $ref: "#/components/schemas/Organization"

    GetPeopleByIdentifierRequest:
      type: object
      properties:
        identifier:
          type: array
          items:
            type: string
            minLength: 1
            pattern: "^urn:(orcid|gismo_id|ugent_id|historic_ugent_id|ugent_barcode|ugent_username|ugent_memorialis_id|biblio_id):.+"
      required: [identifier]

    GetPeopleByIdRequest:
      type: object
      properties:
        id:
          type: array
          items:
            type: string
            minLength: 1
      required: [id]

    GetPeopleRequest:
      type: object
      properties:
        cursor:
          type: string

    SuggestPeopleRequest:
      type: object
      properties:
        limit:
          type: integer
          minimum: 0
          maximum: 100
        query:
          type: string
          minLength: 1
        active:
          type: array
          minItems: 0
          maxItems: 2
          uniqueItems: true
          items:
            type: boolean  
      required: [query]

    SetPersonOrcidRequest:
      type: object
      properties:
        id:
          type: string
          minLength: 1
        orcid:
          type: string
      required: [id, orcid]

    SetPersonTokenRequest:
      type: object
      properties:
        id:
          type: string
          minLength: 1
        type:
          type: string
          minLength: 1
        token:
          type: string
          minLength: 1
      required: [id, type, token]

    SetPersonRoleRequest:
      type: object
      properties:
        id:
          type: string
          minLength: 1
        role:
          type: array
          items:
            type: string
            minLength: 1
      required: [id, role]

    SetPersonSettingsRequest:
      type: object
      properties:
        id:
          type: string
          minLength: 1
        settings:
          type: object
          additionalProperties:
            type: string
      required: [id, settings]

    GetOrganizationRequest:
      type: object
      properties:
        id:
          type: string
          minLength: 1
      required: [id]

    GetOrganizationsByIdentifierRequest:
      type: object
      properties:
        identifier:
          type: array
          items:
            type: string
            minLength: 1
            pattern: "^urn:(gismo_id|ugent_id|biblio_id|ugent_memorialis_id):.+"
      required: [identifier]

    GetOrganizationsByIdRequest:
      type: object
      properties:
        id:
          type: array
          items:
            type: string
            minLength: 1
      required: [id]

    GetOrganizationsRequest:
      type: object
      properties:
        cursor:
          type: string

    SuggestOrganizationsRequest:
      type: object
      properties:
        limit:
          type: integer
          minimum: 0
          maximum: 100
        query:
          type: string
          minLength: 1
      required: [query]