Entities
The call returns the list of entities available for the specific user. Entities API is applicable to patient feedback score (PFS).
Endpoints
GEThttps://api1.consumerism.pressganey.com/api/service/v1/access/entities
GET Request Parameters
Property | Type | Description | Required/Optional |
---|---|---|---|
accessToken | String | Access token received from the platform | Required |
type | String | The type of entity – can be either “Person” or “Location”. | Required |
Sample Response JSON
{
"entities": [
{
"name": "John Doe",
"code": "18963506",
"type": "Person"
},
{
"name": "Jane Doe",
"code": "18963506",
"type": "Person"
}
]
}
Response JSON Parameters
Property | Type | Description |
---|---|---|
entities | Array | Array of entities |
entities.name | String | name of the Provider or Location |
entities.code | String | Unique code of the Provider or Location. For Providers, this is mostly NPI |
entities.type | String | Type of the entity. This can be either a Person or Location |