University of Cambridge group API
Methods for querying and manipulating groups.#### The fetch parameter for groupsAll methods that return groups also accept an optional `fetch`parameter that may be used to request additional information about thegroups returned. For more details about the general rules that apply tothe `fetch` parameter, refer to the `PersonMethods`documentation.For groups the `fetch` parameter may be used to fetch referencesto people, institutions or other groups. In each case, only non-cancelledpeople, institutions and groups will be included when fetching references.The following references are supported:* `"all_members"` - fetches all the people who are members of the group, including members of groups included by the group, and groups included by those groups, and so on.* `"direct_members"` - fetches all the people who are direct members of the group, not taking into account any included groups.* `"members_of_inst"` - if the group is a membership group for an institution, this fetches that institution.* `"owning_insts"` - fetches all the institutions to which the group belongs.* `"manages_insts"` - fetches all the institutions that the group manages. Typically this only applies to "Editor" groups.* `"manages_groups"` - fetches all the groups that this group manages. Note that some groups are self-managed, so this may be a self-reference.* `"managed_by_groups"` - fetches all the groups that manage this group.* `"reads_groups"` - fetches all the groups that this group has privileged access to. This means that members of this group can see the members of the referenced groups regardless of the membership visibility settings.* `"read_by_groups"` - fetches all the groups that have privileged access to this group.* `"includes_groups"` - fetches all the groups included by this group.* `"included_by_groups"` - fetches all the groups that include this group.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 group. For more information about what can be fetched fromreferenced people and institutions, refer to the documentation for`PersonMethods` and `InstitutionMethods`.
University of Cambridge group 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 Group. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and 1 JSON Schema.
This API exposes 10 operations across 10 paths, and defines 9 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 group API declares
1 security scheme
for authenticating requests.
It accepts HTTP basic authentication (basicAuth).
By default, every request must be authenticated.
Paths & Operations 10
Across 10 paths, the API surfaces 10 operations — 10 GET. Each is listed below with its method, path, parameters, and response codes.
Methods for querying and manipulating groups. The fetch parameter for groups All methods that return groups also accept an optional fetch parameter that may be used to request add…
Schemas 9
The contract defines 9 schemas that model the data the API accepts and returns. The most detailed are Group (19 properties), Institution (14 properties), Person (14 properties), Attribute (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 group 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.