Manifest API Exports

Describes how to export all members of a Manifest group with the Manifest API exports endpoints.

All members of a Manifest group can be exported by creating an export request. An export request starts an asynchronous process that generates a single JSON file containing every member of the group, without pagination. Use exports instead of paging through the /groups/{id}/members endpoints when you need the full membership of a large group.

Important Information on Exported Data

The Manifest API exports endpoints do not return the exported data, but instead provide a link in the attribute exportUrl where the data can be retrieved externally. The link is unique and should not be shared with anyone. Make sure to treat the link itself like a password and handle it securely. This link contains a cryptographic signature so that it cannot be guessed by anyone who doesn't know it.

A new exportUrl is generated each time you get a single export, and it expires 10 minutes after it is issued. If the link expires before you download the file, get the export again to obtain a fresh link. If an exportUrl was accidentally shared or leaked, make a DELETE request to the export resource. This deletes the export and its file, and any previously issued exportUrl stops working.

The exported data is a snapshot of the group's membership at the time the export was built and does not change afterwards. Create a new export to get current membership.

Instructions

Follow these steps to create an export and use the exported data.

  1. Create an export request with the name of the group in groupName and the members to include in membershipType. Both attributes are required.

For example, this request creates an export of all members of the group uw:org:my:group

POST https://api.wisc.edu/manifest/exports/groupMembers

Content-Type: application/vnd.api+json

Authorization: Bearer <your_access_token>

{
   "data":{
      "type":"groupMembersExports",
      "attributes":{
         "groupName":"uw:org:my:group",
         "membershipType":"members"
      }
   }
}

A 202 Accepted response indicates the export request has been received. The response body contains the new export with a status of Pending, and the Location header contains the export's URL:

{
   "data":{
      "type":"groupMembersExports",
      "id":"8d4e6f20-1a3b-4c5d-8e9f-a0b1c2d3e4f5",
      "attributes":{
         "groupName":"uw:org:my:group",
         "membershipType":"members",
         "status":"Pending",
         "requestTime":"2026-11-02T16:00:00Z",
         "completionTime":null,
         "exportUrl":null
      },
      "links":{
         "self":"https://api.wisc.edu/manifest/exports/groupMembers/8d4e6f20-1a3b-4c5d-8e9f-a0b1c2d3e4f5"
      }
   },
   "links":{
      "self":"https://api.wisc.edu/manifest/exports/groupMembers/8d4e6f20-1a3b-4c5d-8e9f-a0b1c2d3e4f5"
   }
}

The group must exist and be viewable by your application, otherwise a 400 Bad Request is returned.

  1. Use the self link returned when creating the export (e.g. https://api.wisc.edu/manifest/exports/groupMembers/8d4e6f20-1a3b-4c5d-8e9f-a0b1c2d3e4f5) to check on its status by making a GET request. Large groups can take several minutes or more to export, so wait a few minutes between requests.
  2. When the status of the export is Completed, send a GET request to the URL in the exportUrl attribute to download the exported data. No Authorization header is needed for this request. If the status is Error, create a new export request.

To see all of your application's exports, newest first, make a GET request to /manifest/exports/groupMembers. This list does not include exportUrl; get a single export to obtain a download link. Exports created by other applications are never returned.

Membership Types

The membershipType attribute selects which members are exported. Each value corresponds to the group members endpoint of the same name:

  • members - All members of the group, both direct and indirect.
  • directMembers - Members added directly to the group.
  • indirectMembers - Members who belong to the group through another group.
  • compositeMembers - Members of a composite group.

Exported Data Format

The exported file is a JSON:API document that mirrors the structure of the data returned by the /groups/{id}/members endpoint. It contains a data array with every member, and no pagination links:

{
   "data":[
      {
         "type":"members",
         "id":"1234567890",
         "attributes":{
            "name":"Bucky Badger",
            "netId":"bbadger",
            "emailAddress":"bbadger@wisc.edu"
         },
         "links":{
            "self":"https://api.wisc.edu/manifest/members/1234567890"
         }
      }
   ]
}

Limits and Retention

  • Each application may create 3 exports per hour. Every export created in the previous hour counts toward the limit, including exports that have since been deleted. Requests that are rejected (for example with a 400 Bad Request) do not count.
  • Exceeding the limit returns a 429 Too Many Requests response. The Retry-After header indicates how many seconds to wait before requesting another export.
  • An export and its file are kept for 180 days after the export is requested, after which the export is no longer returned and its file is deleted. Delete an export sooner if you no longer need it.

Timeouts

Exports are expected to finish within 4 hours of the export request; most finish much sooner. If an export has not completed within 4 hours, its status is reported as Error and its completionTime is null. Create a new export request if this happens. Please contact the DoIT API Team if you continue to get exports that result in an error status: api@doit.wisc.edu

Mock Data

The Mock Manifest API supports the same export endpoints, so you can build and test your integration before requesting access. It returns three sample exports, one each with a status of Pending, Completed, and Error. The exportUrl of the completed sample export is not a working download link. Exports you create in the mock API are accepted and validated like real ones, but they are never built: they remain Pending and are not stored permanently. The mock API allows 60 exports per hour.



Keywords:
manifest-api 
Doc ID:
165318
Owned by:
Jared K. in DoIT Enterprise Integration - API Team
Created:
2026-11-06
Updated:
2026-11-06
Sites:
DoIT Enterprise Integration - API Team