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/dhl:dhl-names-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: Dhl Names API
  version: '1.0'
  contact:
    email: info@postdirekt.de
    name: Deutsche Post Direkt GmbH
    url: https://www.postdirekt.de
  license:
    name: Proprietary License
    url: https://www.postdirekt.de
  description: 'Operations tagged Names across 2 of this provider''s published API definitions: dhl-datafactory-autocomplete-20-post-parcel-germany-openapi.yml, dhl-datafactory-autocomplete-20-post-parcel-germany-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- description: Generated server url
  url: https://autocomplete2.postdirekt.de/autocomplete2
security:
- bearerAuth: []
tags:
- name: Names
paths:
  /search/de/firstnames:
    get:
      description: This endpoint returns all the matching first names for the given first name part.
      operationId: getPersons
      parameters:
      - description: first name
        in: query
        name: first_name
        required: false
        schema:
          default: ''
          type: string
      responses:
        '200':
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/FirstNameDataResponse'
          description: OK
        '400':
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: 'At least one of these parameters must be set: first_name].'
        '401':
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Unauthorized - Missing or bad authentication.
        '403':
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Forbidden - User is not authorized.
        '404':
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Not Found - Resource not found.
        '406':
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Not Acceptable - Unsupported content negotiation header (Accept-Header) set. Only JSON is allowed.
        '500':
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal Server Error - An internal server error occured.
        '503':
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Service Unavailable - The service is unavailable.
      summary: Returns all the matching first names for the given first name part
      tags:
      - Names
    servers:
    - description: Generated server url
      url: https://autocomplete2.postdirekt.de/autocomplete2
  /search/de/lastnames:
    get:
      description: This endpoint returns all the matching last names for the given last name part.
      operationId: getLastNames
      parameters:
      - description: last name
        in: query
        name: last_name
        required: false
        schema:
          default: ''
          type: string
      responses:
        '200':
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/LastNameDataResponse'
          description: OK
        '400':
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: 'At least one of these parameters must be set: last_name].'
        '401':
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Unauthorized - Missing or bad authentication.
        '403':
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Forbidden - User is not authorized.
        '404':
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Not Found - Resource not found.
        '406':
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Not Acceptable - Unsupported content negotiation header (Accept-Header) set. Only JSON is allowed.
        '500':
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal Server Error - An internal server error occured.
        '503':
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Service Unavailable - The service is unavailable.
      summary: Returns all the matching last names for the given last name part
      tags:
      - Names
    servers:
    - description: Generated server url
      url: https://autocomplete2.postdirekt.de/autocomplete2
components:
  schemas:
    LastNameDTO:
      properties:
        lastName:
          type: string
        uuid:
          type: string
      type: object
    ErrorResponse:
      properties:
        errorMessage:
          description: The error message.
          example: An error message example.
          type: string
        errorStatus:
          description: The error status code description.
          example: '''Bad Request'''
          type: string
        errorStatusCode:
          description: The HTTP error status code.
          example: 400
          format: int32
          type: integer
      type: object
    LastNameDataResponse:
      properties:
        lastnames:
          items:
            $ref: '#/components/schemas/LastNameDTO'
          type: array
        numFound:
          format: int64
          type: integer
      type: object
    FirstNameDataResponse:
      properties:
        firstnames:
          items:
            $ref: '#/components/schemas/FirstNameDTO'
          type: array
        numFound:
          format: int64
          type: integer
      type: object
    FirstNameDTO:
      properties:
        firstName:
          type: string
        uuid:
          type: string
      type: object
  securitySchemes:
    basicAuth:
      type: http
      scheme: basic
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
x-refined-from:
- dhl-datafactory-autocomplete-20-post-parcel-germany-openapi.yml
- dhl-datafactory-autocomplete-20-post-parcel-germany-openapi.yml