alpha

Get brand kit workspaces

Deprecated: use alpha.brand-kit-workspaces.get.v2 (alpha_brand_kit_workspaces_get_v2), which reads a named kit's revision in its own version, .potx and .dotx template packages included. Get the Brand Kit inventory for the organization (id "organization"), one business profile (its id), or the business profile selected by default (id "default", which profileBinding names; the organization when it has no active profile): each kit's default or active status and the defaults' versions. A named kit's revision a file import added reads with origin manual. Name a kit to also get it, its revision, and its first page of runs. It answers in the values it was published with: a version 3 revision is given in its version 2 form, and a .potx or .dotx template package, which only v2 names, is left out of the document's assetUsage.

get/api/v1/alpha/brand-kit-workspaces/{id}

Request

  • Base URL: https://point11.ai
  • URL: https://point11.ai/api/v1/alpha/brand-kit-workspaces/{id}
  • Auth: one of:
    • HTTP bearer
    • OAuth 2 (authorization code, authorization URL https://auth.point11.ai/oauth2/authorize, token URL https://auth.point11.ai/oauth2/token)

Path parameters

'organization' required
OR
'default' required
OR
string uuid required

Query parameters

kitPageinteger
querystring

Only kits whose name contains this text, ignoring case

sort'updatedAt' | 'name'

updatedAt: the kit's last change. name: ignoring case

direction'asc' | 'desc'
status'active' | 'archived'

Which kits to list: active ones, or archived (retired) ones, read only

kitstring
revisionstring uuid

Headers

Point11-Organizationstring uuid

Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.

Response

Success.

kitPageinteger required
hasMoreKitsboolean required
totalCountinteger required
defaultKitIdstring uuid nullable required

Changes

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