University of Cambridge institution API
Methods for querying and manipulating institutions.#### The fetch parameter for institutionsAll methods that return institutions also accept an optional`fetch` parameter that may be used to request additionalinformation about the institutions returned. For more details aboutthe general rules that apply to the `fetch` parameter,refer to the `PersonMethods` documentation.For institutions the `fetch` parameter may be used to fetchany institution attribute by specifying the `schemeid` of aninstitution attribute scheme. Examples include `"address"`,`"jpegPhoto"`, `"universityPhone"`, `"instPhone"`,`"landlinePhone"`, `"mobilePhone"`, `"faxNumber"`,`"email"` and `"labeledURI"`. The full list (which may beextended over time) may be obtained using `#allAttributeSchemes`.In addition the following pseudo-attributes are supported:* `"phone_numbers"` - fetches all phone numbers. This is equivalent to `"universityPhone,instPhone,landlinePhone,mobilePhone"`.* `"all_attrs"` - fetches all attributes from all institution attribute schemes. This does not include references.* `"contact_rows"` - fetches all institution contact rows. Any chained fetches from contact rows are used to fetch attributes from any people referred to by the contact rows.The `fetch` parameter may also be used to fetch referencedpeople, institutions or groups. This will only include references tonon-cancelled entities. The following references are supported:* `"all_members"` - fetches all the people who are members of the institution.* `"parent_insts"` - fetches all the parent institutions. Note that currently all institutions have only one parent, but this may change in the future, and client applications should be prepared to handle multiple parents.* `"child_insts"` - fetches all the child institutions.* `"inst_groups"` - fetches all the groups that belong to the institution.* `"members_groups"` - fetches all the groups that form the institution's membership list.* `"managed_by_groups"` - fetches all the groups that manage the institution's data (commonly called "Editor" groups).As with person `fetch` parameters, the references may be usedin a chain by using the "dot" notation to fetch additional informationabout referenced people, institutions or groups. For example`"all_members.email"` will fetch the email addresses of all membersof the institution. For more information about what can be fetched fromreferenced people and groups, refer to the documentation for`PersonMethods` and `GroupMethods`.
University of Cambridge institution API is one of 12 APIs that University of Cambridge publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
This API exposes 1 JSON Schema definition.
Tagged areas include institution. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and 1 JSON Schema.
This API exposes 12 operations across 12 paths, and defines 10 schemas. It is described by OpenAPI 3.0.0, at version 1.2.
Requests are made against 2 base URLs: https://lookup-test.srv.uis.cam.ac.uk/api/v1, https://www.lookup.cam.ac.uk/api/v1.
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 1
University of Cambridge institution API declares
1 security scheme
for authenticating requests.
It accepts HTTP basic authentication (basicAuth).
By default, every request must be authenticated.
Paths & Operations 12
Across 12 paths, the API surfaces 12 operations — 12 GET. Each is listed below with its method, path, parameters, and response codes.
Methods for querying and manipulating institutions. The fetch parameter for institutions All methods that return institutions also accept an optional fetch parameter that may be u…
Schemas 10
The contract defines 10 schemas that model the data the API accepts and returns. The most detailed are Group (19 properties), Institution (14 properties), Person (14 properties), AttributeScheme (9 properties). Each schema is shown below with its type and property counts.
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from University of Cambridge 11
Other APIs University of Cambridge publishes across the network.
This is an independent, third-party profile of University of Cambridge institution API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.
The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.
Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.
info@apievangelist.com
·
Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and
you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.