---
title: "GET /v1/projects/{projectsId}/locations/{locationsId}/externalApis/{externalApisId}"
method: GET
path: "/v1/projects/{projectsId}/locations/{locationsId}/externalApis/{externalApisId}"
tags: ["projects"]
---

# GET /v1/projects/{projectsId}/locations/{locationsId}/externalApis/{externalApisId}

`GET /v1/projects/{projectsId}/locations/{locationsId}/externalApis/{externalApisId}`

## Request

- Base URL: `https://apihub.googleapis.com`
- URL: `https://apihub.googleapis.com/v1/projects/{projectsId}/locations/{locationsId}/externalApis/{externalApisId}`
- Auth: one of:
  - OAuth 2 and OAuth 2
    - Implicit: `https://accounts.google.com/o/oauth2/auth`
    - Scopes: `https://www.googleapis.com/auth/apihub.readonly`
    - Authorization code: `https://accounts.google.com/o/oauth2/auth`
    - Token URL: `https://accounts.google.com/o/oauth2/token` scopes: `https://www.googleapis.com/auth/apihub.readonly`
  - OAuth 2 and OAuth 2
    - Implicit: `https://accounts.google.com/o/oauth2/auth`
    - Scopes: `https://www.googleapis.com/auth/apihub.readwrite`
    - Authorization code: `https://accounts.google.com/o/oauth2/auth`
    - Token URL: `https://accounts.google.com/o/oauth2/token` scopes: `https://www.googleapis.com/auth/apihub.readwrite`
  - OAuth 2 and OAuth 2
    - Implicit: `https://accounts.google.com/o/oauth2/auth`
    - Scopes: `https://www.googleapis.com/auth/cloud-platform`
    - Authorization code: `https://accounts.google.com/o/oauth2/auth`
    - Token URL: `https://accounts.google.com/o/oauth2/token` scopes: `https://www.googleapis.com/auth/cloud-platform`
- TypeScript: <https://skmtc.dev/google/apis/apihub/docs/v1/projects/:projectsId/locations/:locationsId/externalApis/:externalApisId/get.ts> (a function with typed inputs; its response is checked against the schema)

Get details about an External API resource in the API hub.

## Path parameters

- `projectsId` string, required
- `locationsId` string, required
- `externalApisId` string, required

## Response `200`

Successful response

- GoogleCloudApihubV1ExternalApi: An external API represents an API being provided by external sources. This can be used to model third-party APIs and can be used to define dependencies.
  - `attributes` object: Optional. The list of user defined attributes associated with the Version resource. The key is the attribute name. It will be of the format: `projects/{project}/locations/{location}/attributes/{attribute}`. The value is the attribute values associated with the resource.
  - `createTime` string, google-datetime: Output only. Creation timestamp.
  - `description` string: Optional. Description of the external API. Max length is 500000 characters (Unicode Code Points).
  - `displayName` string: Required. Display name of the external API. Max length is 500 characters (Unicode Code Points).
  - `documentation` GoogleCloudApihubV1Documentation: Documentation details.
    - `externalUri` string: Optional. The uri of the externally hosted documentation.
  - `endpoints` string[]: Optional. List of endpoints on which this API is accessible.
  - `name` string: Identifier. Format: `projects/{project}/locations/{location}/externalApi/{externalApi}`.
  - `paths` string[]: Optional. List of paths served by this API.
  - `updateTime` string, google-datetime: Output only. Last update timestamp.

## Changes

- **2026-11-08** `09b6c7d2247b`: 4 info
  - the security scope `https://www.googleapis.com/auth/apihub.readonly` was added to the endpoint's security scheme `Oauth2`
  - the security scope `https://www.googleapis.com/auth/apihub.readonly` was added to the endpoint's security scheme `Oauth2c`
  - the security scope `https://www.googleapis.com/auth/cloud-platform` was removed from the endpoint's security scheme `Oauth2`
  - the security scope `https://www.googleapis.com/auth/cloud-platform` was removed from the endpoint's security scheme `Oauth2c`

[Operation history](https://skmtc.dev/google/apis/apihub/changes/v1/projects/:projectsId/locations/:locationsId/externalApis/:externalApisId/get.md)

---

[API](https://skmtc.dev/google/apis/apihub.md) - [All operations](https://skmtc.dev/google/apis/apihub/llms.txt) - [OpenAPI document](https://skmtc.dev/google/apis/apihub/revisions/09b6c7d2247b?raw)