How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

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.

15 operations 15 paths 10 schemas 15 GET

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.0
API Version
1.2
Base URL
https://www.lookup.cam.ac.uk/api/v1/
Authentication
HTTP Basic
Resource Areas
1

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.

person 15

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…

GET
/person/all-attr-schemes
Return a list of all the person attribute schemes available.
Person_allAttributeSchemes → 200default
GET
/person/all-people
Return a list of all people (in batches).
Person_allPeople 4 params → 200default
GET
/person/list
Get the people with the specified identifiers (typically CRSids).
Person_listPeople 2 params → 200default
GET
/person/modified-people
Find all people modified between the specified pair of transactions.
Person_modifiedPeople 7 params → 200default
GET
/person/search
Search for people using a free text query string.
Person_search 9 params → 200default
GET
/person/search-count
Count the number of people that would be returned by a search using a free text query string.
Person_searchCount 5 params → 200default
GET
/person/{scheme}/{identifier}
Get the person with the specified identifier.
Person_getPerson 3 params → 200default
GET
/person/{scheme}/{identifier}/get-attributes
Get one or more (possibly multi-valued) attributes of a person.
Person_getAttributes 3 params → 200default
GET
/person/{scheme}/{identifier}/groups
Get all the groups to which the specified person belongs, including indirect group memberships, via groups that include other groups.
Person_getGroups 3 params → 200default
GET
/person/{scheme}/{identifier}/insts
Get all the institutions to which the specified person belongs.
Person_getInsts 3 params → 200default
GET
/person/{scheme}/{identifier}/is-member-of-group/{groupid}
Test if the specified person is a member of the specified group.
Person_isMemberOfGroup 3 params → 200default
GET
/person/{scheme}/{identifier}/is-member-of-inst/{instid}
Test if the specified person is a member of the specified institution.
Person_isMemberOfInst 3 params → 200default
GET
/person/{scheme}/{identifier}/manages-groups
Get all the groups that the specified person has persmission to edit.
Person_getManagedGroups 3 params → 200default
GET
/person/{scheme}/{identifier}/manages-insts
Get all the institutions that the specified person has permission to edit.
Person_getManagedInsts 3 params → 200default
GET
/person/{scheme}/{identifier}/{attrid}
Get a specific attribute of a person.
Person_getAttribute 3 params → 200default

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.

Identifier
object
Class representing a person's identifier, for use by the web service API.
2 properties
ContactRow
object
Class representing an institution contact row, for use by the web services API.
8 properties
Error
object
Class representing an error returned by the web service API.
4 properties
Attribute
object
Class representing an attribute of a person or institution returned by the web service API. Note that for institution attributes, the instid, visibility and ow…
9 properties
ContactWebPage
object
Class representing a web page referred to by an institution contact row, for use by the web service API.
2 properties
Person
object
Class representing a person returned by the web service API. Note that the identifier is the person's primary identifier (typically their CRSid), regardless of…
14 properties
Institution
object
Class representing an institution returned by the web service API.
14 properties
Group
object
Class representing a group returned by the web service API.
19 properties
AttributeScheme
object
Class representing an attribute scheme. This may apply to attributes of people or institutions.
9 properties
ContactPhoneNumber
object
Class representing a phone number held on an institution contact row, for use by the web service API.
3 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

university-of-cambridge-person-api-openapi.yml Raw ↑

Other APIs University of Cambridge publishes across the network.

Raven Authentication (OAuth2 / OpenID Connect)
Cambridge API Gateway (Card / Student / HR)
Apollo Institutional Repository API (DSpace)
University of Cambridge group API
University of Cambridge ibis API
University of Cambridge institution API
Cambridge Shibboleth Identity Provider (SAML 2.0 metadata)
Apollo OAI-PMH metadata harvesting endpoint
Cambridge Digital Library IIIF APIs
iDiscover library discovery (Ex Libris Primo VE) — TENANT
Symplectic Elements research information system — TENANT
Where this information came from

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.