GET v1/{Client}/Indexes/{IndexId}

Gets one Index.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
Client

The code of the Client database to connect to.

 string

Required
IndexId

The Id of the Index.

 integer

Required

Body Parameters

None.

Response Information

Resource Description

GranicusIndex
NameDescriptionTypeAdditional information
IndexId

integer

None.
IndexGuid

string

None.
IndexLastModifiedUtc

date

None.
IndexRowVersion

Collection of byte

None.
IndexName

string

Required
IndexActiveFlag

integer

None.
IndexUsedFlag

integer

None.
api_metadata

string

None.

Response Formats

application/json, text/json

Sample: 
{
  "IndexId": 1,
  "IndexGuid": "sample string 2",
  "IndexLastModifiedUtc": "2025-11-04T07:09:13.6110478-05:00",
  "IndexRowVersion": "QEA=",
  "IndexName": "sample string 4",
  "IndexActiveFlag": 5,
  "IndexUsedFlag": 6,
  "api_metadata": "sample string 7"
}

application/xml, text/xml

Sample: 
<GranicusIndex xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/LegistarWebAPI.Models.v1">
  <IndexActiveFlag>5</IndexActiveFlag>
  <IndexGuid>sample string 2</IndexGuid>
  <IndexId>1</IndexId>
  <IndexLastModifiedUtc>2025-11-04T07:09:13.6110478-05:00</IndexLastModifiedUtc>
  <IndexName>sample string 4</IndexName>
  <IndexRowVersion>QEA=</IndexRowVersion>
  <IndexUsedFlag>6</IndexUsedFlag>
  <api_metadata>sample string 7</api_metadata>
</GranicusIndex>

text/javascript, application/javascript, application/json-p

Sample: 
({"IndexId":1,"IndexGuid":"sample string 2","IndexLastModifiedUtc":"2025-11-04T07:09:13.6110478-05:00","IndexRowVersion":"QEA=","IndexName":"sample string 4","IndexActiveFlag":5,"IndexUsedFlag":6,"api_metadata":"sample string 7"});