Returns a particular portal by id

Required roles:

  • can_read_portals
get/v1/portals/{portal_id}/

Request

Path parameters

portal_idstring required

Query parameters

include_usersboolean

include info about the user who created this portal

Headers

App-IDstring required
Auth-Tokenstring required

Response

Returns a portal

created_by_userstring uuid
date_createdstring date-time
date_modifiedstring date-time
descriptionstring nullable
idstring uuid
keyframesobject[]
logostring
logo_storage_idstring uuid
namestring required
playlist_idstring uuid
status'ACTIVE'
system_domain_idstring uuid

Changes

No recorded changes to this operation across all 1 revision of this API.