Collection sharing in Postman - Build an Automation Script

Verify sharing a Postman collection with a team member

Preconditions (3)

Step 1: Open Postman and navigate to the 'User API Tests' collection

Step 2: Click on the 'Share' button for the collection

Step 3: Enter '[e-mail]' in the invite field

Step 4: Set permission to 'Can Edit'

Step 5: Click 'Send Invite'

Step 6: Verify that the team member receives the invitation

Step 7: Verify that the team member can access and edit the collection

✅ Expected Result: The team member receives the invite and can access and edit the 'User API Tests' collection

Automation Requirements - Postman API with Newman

Assertions Needed:

Verify the collection is shared with the specified email

Verify the permission level is 'Can Edit'

Verify the team member can access the collection via API

Best Practices:

Use Postman API endpoints to automate collection sharing

Use environment variables for emails and collection IDs

Validate API responses with clear assertions

Handle authentication securely with API keys or tokens

Automated Solution

Postman

import requests

# Set variables
postman_api_key = 'YOUR_POSTMAN_API_KEY'
collection_uid = 'YOUR_COLLECTION_UID'
team_member_email = '[e-mail]'

headers = {
    'X-Api-Key': postman_api_key,
    'Content-Type': 'application/json'
}

# Step 1: Get current collection details
collection_url = f'https://api.getpostman.com/collections/{collection_uid}'
response = requests.get(collection_url, headers=headers)
response.raise_for_status()
collection_data = response.json()

# Step 2: Share collection with team member
share_url = f'https://api.getpostman.com/collections/{collection_uid}/share'
payload = {
    "sharedWith": [
        {
            "email": team_member_email,
            "permission": "edit"
        }
    ]
}
share_response = requests.post(share_url, headers=headers, json=payload)
share_response.raise_for_status()

# Step 3: Verify sharing
verify_response = requests.get(collection_url, headers=headers)
verify_response.raise_for_status()
shared_with = verify_response.json().get('collection', {}).get('sharedWith', [])

assert any(user.get('email') == team_member_email and user.get('permission') == 'edit' for user in shared_with), "Collection not shared correctly"

print('Test Passed: Collection shared with team member with edit permission.')

This script uses the Postman API to automate sharing a collection.

First, it fetches the collection details to confirm the collection exists.

Then, it sends a POST request to share the collection with the specified team member email and sets permission to 'edit'.

Finally, it verifies by fetching the collection details again and checking if the team member is listed with the correct permission.

Assertions ensure the sharing was successful. Using environment variables for keys and IDs keeps the script flexible and secure.

Common Mistakes - 3 Pitfalls

Hardcoding API keys directly in the script

Not checking API response status before proceeding

Assuming the team member has accepted the invite without verification

Bonus Challenge

Now add data-driven testing to share the collection with 3 different team member emails and permissions

Show Hint

Practice

1.

What is the main purpose of Collection sharing in Postman?

easy

A. To allow team members to access and work on the same API requests easily

B. To create new APIs from scratch

C. To delete collections permanently

D. To run automated tests only on local machines

Solution

1. Step 1: Understand the concept of collection sharing

   Collection sharing is designed to help teams collaborate by giving access to the same set of API requests.

2. Step 2: Identify the main purpose

   The main goal is to let team members work together easily on the same collection.

3. Final Answer:

   To allow team members to access and work on the same API requests easily -> Option A

4. Quick Check:

   Collection sharing = team collaboration [OK]

Hint: Sharing means working together on the same collection [OK]

Common Mistakes:

• Thinking sharing creates new APIs
• Confusing sharing with deleting collections
• Believing sharing only runs tests locally

2.

Which of the following is a valid way to share a Postman collection?

easy

A. Only export and send the file

B. All of the above methods are valid

C. Only share using a public link

D. Only share via workspace

Solution

1. Step 1: Review sharing methods in Postman

   Postman allows sharing collections by exporting files, sharing in workspaces, or using public links.

2. Step 2: Confirm all methods are valid

   Each method suits different collaboration needs, so all are valid ways.

3. Final Answer:

   All of the above methods are valid -> Option B

4. Quick Check:

   Export + workspace + link = all valid [OK]

Hint: Remember: export, workspace, and link all share collections [OK]

Common Mistakes:

• Choosing only one sharing method
• Ignoring public link sharing
• Confusing export with import

3.

What will happen if you share a collection via a workspace in Postman?

medium

A. Team members in the workspace can access and edit the collection

B. Only you can access the collection

C. The collection is deleted from your account

D. The collection becomes read-only for everyone

Solution

1. Step 1: Understand workspace sharing in Postman

   Sharing a collection in a workspace allows all workspace members to access and collaborate on it.

2. Step 2: Identify access rights

   Members can view and edit the collection, enabling teamwork.

3. Final Answer:

   Team members in the workspace can access and edit the collection -> Option A

4. Quick Check:

   Workspace sharing = team access and edit [OK]

Hint: Workspace sharing means team can edit collection [OK]

Common Mistakes:

• Thinking only owner can access
• Believing collection is deleted after sharing
• Assuming collection is read-only

4.

You tried to share a collection via a public link, but your teammates cannot access it. What is the most likely reason?

medium

A. Public link sharing is not supported in Postman

B. The collection was shared in a workspace instead

C. The link was not generated or copied correctly

D. The collection was deleted before sharing

Solution

1. Step 1: Check the sharing method used

   If teammates cannot access via public link, the link might be wrong or missing.

2. Step 2: Rule out other causes

   Public link sharing is supported, and workspace sharing is different. Deletion would prevent all access.

3. Final Answer:

   The link was not generated or copied correctly -> Option C

4. Quick Check:

   Wrong or missing link = access denied [OK]

Hint: Verify link correctness if access fails [OK]

Common Mistakes:

• Assuming public link sharing is unsupported
• Confusing workspace sharing with link sharing
• Ignoring link copy errors

5.

You want to share a collection with a team that has mixed access needs: some should edit, others only view. Which sharing method best fits this requirement?

hard

A. Share via a public link with edit permissions

B. Share the collection by copying requests manually

C. Export the collection and email it to everyone

D. Share the collection in a workspace with role-based access

Solution

1. Step 1: Analyze sharing needs

   Mixed access means some users can edit, others only view.

2. Step 2: Identify sharing method supporting roles

   Workspaces in Postman support role-based access control, allowing this setup.

3. Step 3: Rule out other methods

   Public links usually have uniform access; exporting or manual copying lacks access control.

4. Final Answer:

   Share the collection in a workspace with role-based access -> Option D

5. Quick Check:

   Workspace + roles = mixed access control [OK]

Hint: Use workspace roles for mixed edit/view access [OK]

Common Mistakes:

• Using public links without access control
• Emailing exports causes version mismatch
• Copying requests manually is inefficient