Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

ESRI ArcGIS Portal API

Portal items, users, groups, and organizational management

ESRI ArcGIS Portal API is one of 8 APIs that ESRI ArcGIS publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Portal. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, authentication docs, and an API reference.

This API exposes 5 operations across 5 paths, and defines 7 schemas. It is described by OpenAPI 3.1.0, at version 1.0.0.

Requests are made against 4 base URLs: https://www.arcgis.com/sharing/rest, https://geocode.arcgis.com/arcgis/rest/services/World/GeocodeServer, https://route.arcgis.com/arcgis/rest/services, https://places-api.arcgis.com/arcgis/rest/services/v1.

5 operations 5 paths 7 schemas 5 GET

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
1.0.0
Base URL
https://www.arcgis.com/sharing/rest
Authentication
API Key, OAuth 2.0
Resource Areas
1

Authentication & Security 2

ESRI ArcGIS Portal API declares 2 security schemes for authenticating requests. An API key is passed in the query as token (ApiKeyAuth). It supports OAuth 2.0 (OAuth2) using the authorizationCode flow, exposing 2 scopes. By default, every request must be authenticated.

  • ApiKeyAuth — ArcGIS API key or token

Paths & Operations 5

Across 5 paths, the API surfaces 5 operations — 5 GET. Each is listed below with its method, path, parameters, and response codes.

Portal 5

Portal items, users, groups, and organizational management

GET
/portals/self
Get portal information
getPortalSelf 2 params → 200401
GET
/community/users/{username}
Get user profile
getUser 2 params → 200404
GET
/content/users/{username}/items
List user content items
getUserItems 6 params → 200
GET
/content/items/{itemId}
Get portal item
getItem 2 params → 200404
GET
/search
Search portal content
searchPortal 6 params → 200

Schemas 7

The contract defines 7 schemas that model the data the API accepts and returns. The most detailed are Item (16 properties), User (11 properties), Portal (9 properties), SearchResults (6 properties). Each schema is shown below with its type and property counts.

User
object
11 properties
ItemCollection
object
5 properties
Item
object
16 properties
SearchResults
object
6 properties
Error
object
1 property
Portal
object
9 properties
GroupRef
object
3 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

esri-arcgis-portal-api-openapi.yml Raw ↑

Other APIs ESRI ArcGIS publishes across the network.

ArcGIS Maps SDK for JavaScript
ArcGIS API for Python
ArcGIS Geocoding Service
ArcGIS Routing Service
ArcGIS Places Service
ESRI ArcGIS Geocoding API
ESRI ArcGIS Places API