Skip to navigation
API ReferenceBundles

Get Bundle Member

Beta

Resolve a bundle member’s name, support-desk/support_agent, to this workspace’s own asset: its id, type and link, and with track the revision that track serves. The caller needs view access to the bundle as a member of its workspace, and to the member. Every refusal is 404, the same answer a name that doesn’t exist gets.

Authentication

X-API-KEYstring
API Key authentication via header

Path parameters

bundle_keystringRequired1-63 characters
The bundle's permanent key.
member_keystringRequired1-63 characters
The member's permanent key.

Headers

X-Athena-Session-CredentialstringOptional

Query parameters

workspace_idstring or nullOptional1-128 characters

The workspace to resolve in. Optional for a caller with one workspace, and for a credential bound to one (a page’s, a computer’s); a caller in several names it. The caller must be a member.

trackstring or nullOptional1-32 characters

A track’s key (production, pilot…): answer with the revision it serves. The caller must be on the track.

Response

Successful Response
asset_idstring
This place's asset for the member.
bundle_keystring
The bundle's permanent key.
member_keystring
The member's permanent key.
typestring

The member asset’s type, e.g. collab_agent.

revisionobject or nullOptional

With a track, the revision it serves of the member (null for a followed member); null without a track.

trackstring or nullOptional

The track the answer read; null when none was asked for.

Errors

400
Bad Request Error
404
Not Found Error
422
Unprocessable Entity Error