Reviews API (1.0.0)

Download OpenAPI specification:

Please contact your account manager with any queries, or if in doubt email support@studentcrowd.com.

Request Rate Limiting

To ensure the stability and performance of our API for all users, we have implemented a request rate limit. This rate limit is designed to prevent excessive usage that could impact the service quality for other users.

Rate Limit Details:

Request Limit: 60 requests
Time Window: 60 seconds (1 minute)

This means that within any given 60-second window, a maximum of 60 requests can be made to the API from a single client (identified by an API key or IP address). If the number of requests exceeds this limit, additional requests will be temporarily blocked until the start of the next time window.

Versioning & Integration Guidelines

Our APIs follow a documented versioning and deprecation policy: backward-compatible changes can land at any time, while breaking changes require a new API version with advance notice. See the API Versioning & Integration Guidelines for the full policy, integration best practices, and how changes are communicated.

List subjects

Returns a paginated list of subjects (halls) with recent reviews information. Results can be filtered by country and index IDs based on user permissions.

query Parameters

size	integer <int32> <= 100 Default: 100 Number of results to return

Responses

Response samples

200
429

Content type

application/json

{"data": [{"id": "550e8400-e29b-41d4-a716-446655440000",
"index": 1008327,
"name": "Kingsley Lodge",
"provider": "Student Crowd",
"recent_reviews": {"uri": "/api/subjects/1008327/recent-reviews",
"count": 15
}
}
],
"links": {"self": "/api/subjects?page=1",
"first": "/api/subjects?page=1",
"prev": "/api/subjects?page=2",
"next": "/api/subjects?page=4",
"last": "/api/subjects?page=10"
}
}

Recent reviews by subject

Returns recent reviews for a specific subject (hall) identified by subject code (index ID). Results can be filtered by country based on user permissions.

path Parameters

subjectCode

required

number

Subject Code (Index ID)

Responses

Response samples

200
429

Content type

application/json

{"data": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"text": "I have loved my time at this University",
"author": "member11110373",
"pinned": true,
"ratings": {"facilities": 5,
"clubs": 5,
"union": 1,
"careers": 4,
"internet": 4
},
"average_rating": 3.8,
"userType": "CURRENT",
"studentType": "UK",
"created_at": {"date": "2018-10-22 11:29:24.000000",
"timezone_type": 3,
"timezone": "UTC"
},
"updated_at": {"date": "2018-10-22 11:29:24.000000",
"timezone_type": 3,
"timezone": "UTC"
}
}
],
"meta": {"type": "institution",
"score": 4.65,
"uri": "string"
}
}

Recent reviews by UKPRN

path Parameters

ukprn

required

number

UKPRN

query Parameters

includeReplies

boolean

Default: false

Include the list of replies within the review object.

Responses

Response samples

200

Content type

application/json

{"data": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"text": "I have loved my time at this University",
"author": "member11110373",
"pinned": true,
"ratings": {"facilities": 5,
"clubs": 5,
"union": 1,
"careers": 4,
"internet": 4
},
"average_rating": 3.8,
"userType": "CURRENT",
"studentType": "UK",
"created_at": {"date": "2018-10-22 11:29:24.000000",
"timezone_type": 3,
"timezone": "UTC"
},
"updated_at": {"date": "2018-10-22 11:29:24.000000",
"timezone_type": 3,
"timezone": "UTC"
},
"replies": [{"content": "Thank you for the five star review! We're so pleased you have enjoyed your student experience and felt supported!",
"author": "Student Crowd Team",
"created_at": {"date": "2018-10-22 11:29:24.000000",
"timezone_type": 3,
"timezone": "UTC"
},
"updated_at": {"date": "2018-10-22 11:29:24.000000",
"timezone_type": 3,
"timezone": "UTC"
}
}
]
}
],
"meta": {"type": "institution",
"score": 4.65,
"uri": "string"
}
}