Update the API documentation - Get Single Collection

[cyrielle-hada]

Update the API documentation https://docs.api.getpostman.com/?version=latest#647806d5-492a-eded-1df6-6529b5dc685c

Our current API documentation says that we're able to GET a single collection with collection uid using the endpoint https://api.getpostman.com/collections/{{collection_uid}}.

It is now supported that the endpoint works as well using the collection_id.

[stale[bot]]

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.

[arlemi]

@cyrielle-hada I tried to get the https://api.getpostman.com/collections/{{collection_uid}} endpoint work using the collection_id instead of collection_uid but couldn't get it to work. Do you have any more info on how this is supposed to work?

(also yes, it's almost a year later... better late than never 🙈 )

[DannyDainton]

@arlemi I've just tried this against my account with both the id and uid key values, taken from the All Collections endpoint. The single collection was being returned when I used either value. 🤷‍♂ 😄

[arlemi]

Tried a bit more, id works only for collections that are in your personal workspace, for other collections, it gives the following error:

{
    "error": {
        "name": "instanceNotFoundError",
        "message": "We could not find the collection you are looking for"
    }
}

uid works for all collections that you have access to.

Can one of you confirm?

[DannyDainton]

@arlemi That sounds and looks about right to me.

I had a collection in a Team Workspace, using the id value gave me a 404 and that same response message you received.

Using the uid returned the single collection as I had access to that one.