v1

latestOpenAPI 3.0.02026-07-2653703.5 MB
orgs/readers

Describe an owned or assigned reader

Possible comma separated values for the options parameter include: withEffectiveLocationRestriction. The withEffectiveLocationRestriction option causes current effective location restriction to be included in the response. Only readers with an effective location restriction include this object.<br/><br/>JWT is required for this endpoint with at least one of the following scopes: o{params.orgId}-dashActivity:w,o{params.orgId}-dashActivity:r,o{params.orgId}-dashCust:w,o{params.orgId}-dashCust:r,o{params.orgId}-hw:w,o{params.orgId}-hw:r,o{params.orgId}-dash:w,o{params.orgId}-dash:r,o{params.orgId}-site:w,o{params.orgId}-site:r,o{params.orgId}-siteGeneral:w,o{params.orgId}-siteGeneral:r,o:w,o:r,s-o:w,s-o:r<br/><br/>Endpoint name: describeReader

get/orgs/{orgId}/readers/{readerId}

Path parameters

orgIdinteger required
readerIdinteger required

Query parameters

optionsstring

Response

Successful