import { getGroup } from "@esri/arcgis-rest-portal";
getGroup("fxb988") // id

Fetch a group using its id. See the REST Documentation for more information.


Parameter Type Default Notes
id Required string

Group Id

requestOptions Optional IRequestOptions

Options for the request

Available requestOptions

Property Type Notes
authentication Optional IAuthenticationManager

The instance of IAuthenticationManager to use to authenticate this request.

credentials Optional RequestCredentials

A string indicating whether credentials (cookies) will be sent with the request. Used internally for authentication workflows.

fetch Optional function(input: RequestInfo, init: RequestInit) : Promise<Response>

The implementation of fetch to use. Defaults to a global fetch.

headers Optional [key: string]: any

Additional Headers to pass into the request.

hideToken Optional boolean

Prevents the token from being passed in a URL Query param that is saved in browser history. Instead, the token will be passed in POST request body or through X-Esri-Authorization header. NOTE: This will force POST requests in browsers since auth header is not yet supported by preflight OPTIONS check with CORS.

httpMethod Optional HTTPMethods

The HTTP method to send the request with.

maxUrlLength Optional number

If the length of a GET request's URL exceeds maxUrlLength the request will use POST instead.

params Optional IParams

Additional parameters to pass in the request.

portal Optional string

Base url for the portal you want to make the request to. Defaults to authentication.portal if authentication exists, otherwise to ''.

rawResponse Optional boolean

Return the raw response


A Promise that will resolve with the data from the response.

Property Type Notes
autoJoin boolean
created number
id string
isFav boolean
isInvitationOnly boolean
isViewOnly boolean
modified number
owner string
protected boolean
tags string[] | string
access Inherited "private" | "org" | "public"
title Inherited string
hasCategorySchema Optional boolean
isOpenData Optional boolean
userMembership Optional {
description Optional Inherited string
phone Optional Inherited string
snippet Optional Inherited string
sortField Optional Inherited "title" | "owner" | "avgrating" | "numviews" | "created" | "modified"
sortOrder Optional Inherited "asc" | "desc"
thumbnail Optional Inherited string

Function defined in packages/arcgis-rest-portal/src/groups/get.ts:53