# University of Cambridge group API **Canonical:** https://apis.io/apis/university-of-cambridge/university-of-cambridge-group-api/ **Provider:** University of Cambridge — https://apis.io/providers/university-of-cambridge/ **Base URL:** https://www.lookup.cam.ac.uk/api/v1/ **Documentation:** https://www.lookup.cam.ac.uk/doc/ws-doc/ University of Cambridge group API is one of 12 APIs that [University of Cambridge](https://apis.io/providers/university-of-cambridge/) publishes on the [APIs.io](https://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. 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 additional information about the groups returned. For more details about the general rules that apply to the `fetch` parameter, refer to the `PersonMethods` documentation. For groups the `fetch` parameter may be used to fetch references to people, institutions or other groups. In each case, only non-cancelled people, 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 used in a chain by using the "dot" notation to fetch additional information about referenced people, institutions or groups. For example `"all_members.email"` will fetch the email addresses of all members of the group. For more information about what can be fetched from referenced people and institutions, refer to the documentation for `PersonMethods` and `InstitutionMethods`. ## Machine-readable artifacts (8) - **OpenAPI** — https://raw.githubusercontent.com/api-evangelist/university-of-cambridge/refs/heads/main/openapi/university-of-cambridge-group-api-openapi.yml - **Documentation** — https://www.lookup.cam.ac.uk/doc/ws-doc/ - **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/university-of-cambridge/refs/heads/main/json-schema/university-of-cambridge-person-schema.json - **x-json-structure** — https://raw.githubusercontent.com/api-evangelist/university-of-cambridge/refs/heads/main/json-structure/university-of-cambridge-person-structure.json - **x-examples** — https://raw.githubusercontent.com/api-evangelist/university-of-cambridge/refs/heads/main/examples/university-of-cambridge-person-example.json - **x-spectral-rules** — https://raw.githubusercontent.com/api-evangelist/university-of-cambridge/refs/heads/main/rules/university-of-cambridge-rules.yml - **x-vocabulary** — https://raw.githubusercontent.com/api-evangelist/university-of-cambridge/refs/heads/main/vocabulary/university-of-cambridge-vocabulary.yml - **x-json-ld-context** — https://raw.githubusercontent.com/api-evangelist/university-of-cambridge/refs/heads/main/json-ld/university-of-cambridge-context.jsonld ## Other University of Cambridge APIs (11) - [Raven Authentication (OAuth2 / OpenID Connect)](https://apis.io/apis/university-of-cambridge/raven/) - [Cambridge API Gateway (Card / Student / HR)](https://apis.io/apis/university-of-cambridge/gateway/) - [Apollo Institutional Repository API (DSpace)](https://apis.io/apis/university-of-cambridge/apollo/) - [University of Cambridge ibis API](https://apis.io/apis/university-of-cambridge/university-of-cambridge-ibis-api/) - [University of Cambridge institution API](https://apis.io/apis/university-of-cambridge/university-of-cambridge-institution-api/) - [University of Cambridge person API](https://apis.io/apis/university-of-cambridge/university-of-cambridge-person-api/) - [Cambridge Shibboleth Identity Provider (SAML 2.0 metadata)](https://apis.io/apis/university-of-cambridge/shibboleth-idp/) - [Apollo OAI-PMH metadata harvesting endpoint](https://apis.io/apis/university-of-cambridge/apollo-oai-pmh/) - [Cambridge Digital Library IIIF APIs](https://apis.io/apis/university-of-cambridge/cudl-iiif/) - [iDiscover library discovery (Ex Libris Primo VE) — TENANT](https://apis.io/apis/university-of-cambridge/idiscover-primo/) - [Symplectic Elements research information system — TENANT](https://apis.io/apis/university-of-cambridge/elements-symplectic/) ## Tags Group --- Profiled by [API Evangelist](https://apievangelist.com) and published on [APIs.io](https://apis.io/apis/university-of-cambridge/university-of-cambridge-group-api/). The API's provider profile, Kin Score and agent-readiness rating are at https://apis.io/providers/university-of-cambridge/.