University of Cambridge person API
Methods for querying and manipulating people.#### Notes on the fetch parameterAll methods that return people, institutions or groups also accept anoptional `fetch` parameter that may be used to requestadditional information about the entities returned. Without thisparameter, only a few basic details about each person, institution orgroup are returned. The `fetch` parameter is quite flexible,and may be used in a number of different ways:* **Attribute fetching**. Attributes may be fetched by specifying the `schemeid` of an attribute scheme. For example to fetch a person's email addresses, use the value `"email"`. For people common attribute schemes include `"jpegPhoto"`, `"misAffiliation"`, `"title"`, `"universityPhone"`, `"landlinePhone"`, `"mobilePhone"`, `"pager"`, `"labeledURI"` and `"address"`. The full list of person attribute schemes may be obtained using `#allAttributeSchemes`.* **Pseudo-attributes**. Certain special pseudo-attributes are defined for convenience. For people, the following pseudo-attributes are supported: * `"phone_numbers"` - fetches all phone numbers. This is equivalent to `"universityPhone,instPhone,landlinePhone,mobilePhone,pager"`. * `"all_identifiers"` - fetches all identifiers. Currently people only have CRSid identifiers, but in the future additional identifiers such as USN or staffNumber may be added. * `"all_attrs"` - fetches all attributes from all person attribute schemes. This does not include identifiers or references.* **Reference fetching**. For people, the following references are supported (and will fetch only non-cancelled institutions and groups): * `"all_insts"` - fetches all the institutions to which the person belongs (sorted in name order). * `"all_groups"` - fetches all the groups that the person is a member of, including indirect group memberships, via groups that include other groups. * `"direct_groups"` - fetches all the groups that the person is directly a member of. This does not include indirect group memberships - i.e., groups that include these groups.* **Chained reference fetching**. To fetch properties of referenced objects, the "dot" notation may be used. For example, to fetch the email addresses of all the institutions to which a person belongs, use `"all_insts.email"`. Chains may include a number of reference following steps, for example `"all_insts.managed_by_groups.all_members.email"` will fetch all the institutions to which the person belongs, all the groups that manage those institutions, all the visible members of those groups and all the email addresses of those managing group members. For more information about what can be fetched from referenced institutions and groups, refer to the documentation for `InstitutionMethods` and `GroupMethods`.Multiple values of the `fetch` parameter should be separatedby commas.#### Fetch parameter examples`fetch = "email"`This fetches all the person's email addresses.`fetch = "title,address"`This fetches all the person's titles (roles) and addresses.`fetch = "all_attrs"`This fetches all the person's attributes.`fetch = "all_groups,all_insts"`This fetches all the groups and institutions to which the person belongs.`fetch = "all_insts.parent_insts"`This fetches all the person's institutions, and their parent institutions.`fetch = "all_insts.email,all_insts.all_members.email"`This fetches all the person's institutions and their email addresses, andall the members of those institutions, and the email addresses of allthose members.
University of Cambridge person 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 Persons. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and 1 JSON Schema.
This API exposes 15 operations across 15 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 person API declares
1 security scheme
for authenticating requests.
It accepts HTTP basic authentication (basicAuth).
By default, every request must be authenticated.
Paths & Operations 15
Across 15 paths, the API surfaces 15 operations — 15 GET. Each is listed below with its method, path, parameters, and response codes.
Methods for querying and manipulating people. Notes on the fetch parameter All methods that return people, institutions or groups also accept an optional fetch parameter that may…
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 person 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.