Skip to main content

Get Workspace Info

GET 
/auth/portal/v1/me

Get Workspace Info

Request​

Header Parameters

    X-API-KEY stringrequired

    API Key

Responses​

OK

Schema

    api_key

    object

    created_at string

    CreatedAt is the time the API key was created.

    created_by string

    CreatedBy is the user who created the API key.

    description string

    Description is the description of the API key.

    expires_at string

    ExpiresAt is the time the API key will expire.

    id string

    ID is the unique identifier of the API key.

    name string

    Name is the name of the API key.

    permissions string[]

    Permissions is the permissions of the API key.

    tenant_id string

    TenantID is workspace ID.

    naming_settings

    object[]

    NamingSettings contains each entity, its singular and plural name

  • Array [

    • created_at string

    CreatedAt is the time the naming settings was created

    entity_name string

    EntityName is the entity name for the name provided (e.g. "feature")

    id string

    ID is the unique identifier of the naming settings

    name string

    Name is the singular name of the entity

    plural_name string

    PluralName is the plural name of the entity

  • ]

    • workspace_customer_type string

    CustomerType is the type of the workspace customer, Can be "B2B" or "B2C"

    workspace_id string

    ID is the unique identifier of the user

    workspace_name string

    Name is the name of the workspace

Loading...