Skip to main content

Entities (Deprecated)

The call returns the list of entities available for the specific user. Entities API is applicable to patient feedback score (PFS).

Note: This API is deprecated. and will be removed in a future release. Use the new entities API instead.

Endpoints​

GEThttps://api1.consumerism.pressganey.com/api/service/v1/access/entities

GET Request Parameters​

PropertyTypeDescriptionRequired/Optional
accessTokenStringAccess token received from the platformRequired
typeStringThe 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​

PropertyTypeDescription
entitiesArrayArray of entities
entities.nameStringname of the Provider or Location
entities.codeStringUnique code of the Provider or Location. For Providers, this is mostly NPI
entities.typeStringType of the entity. This can be either a Person or Location