Skip to main content

Retrieve a Theme

GET 

/themes/:theme_id

Retrieves a theme created with the authenticated client

Request

Path Parameters

    theme_id cuidrequired

    The ID of the theme to retrieve

Responses

GET /themes/:theme_id Successful response

Schema
    version stringrequired

    Possible values: [1.0]

    The version of the response schema

    result_type stringrequired

    Possible values: [single]

    A single object of the theme resource.

    resource_type stringrequired

    Possible values: [theme]

    Data contains the theme resource.

    data objectrequired

    The resource data.

    id cuidrequired

    The unique identifier of the theme

    resource_type stringrequired

    Possible values: [theme]

    logo objectrequired

    The logo of the theme. This is displayed to the user in all communication and touch points.

    version stringrequired

    Possible values: [1.0]

    The version of the response schema

    result_type stringrequired

    Possible values: [single]

    A single object of the file resource.

    resource_type stringrequired

    Possible values: [file]

    Data contains the file resource.

    data objectrequired

    The resource data.

    id cuidrequired

    The unique identifier of the file

    resource_type stringrequired

    Possible values: [file]

    filename stringrequired

    Possible values: non-empty

    The complete filename including the file extension

    mime_type stringrequired

    Possible values: non-empty

    The mime type of the file

    url url

    The signed read url of the file

    metadata object
    lookup_key stringrequired

    A provided lookup key provided by you to help you identify the file.

    created_at stringrequired

    UTC datetime ISO string

    updated_at stringrequired

    UTC datetime ISO string

    icon objectrequired

    The icon of the theme. This is used for the favicon.

    version stringrequired

    Possible values: [1.0]

    The version of the response schema

    result_type stringrequired

    Possible values: [single]

    A single object of the file resource.

    resource_type stringrequired

    Possible values: [file]

    Data contains the file resource.

    data objectrequired

    The resource data.

    id cuidrequired

    The unique identifier of the file

    resource_type stringrequired

    Possible values: [file]

    filename stringrequired

    Possible values: non-empty

    The complete filename including the file extension

    mime_type stringrequired

    Possible values: non-empty

    The mime type of the file

    url url

    The signed read url of the file

    metadata object
    lookup_key stringrequired

    A provided lookup key provided by you to help you identify the file.

    created_at stringrequired

    UTC datetime ISO string

    updated_at stringrequired

    UTC datetime ISO string

    primary_color string

    Default value: #000000

    The primary color used to create the color palette in the signing room.

    metadata object
    lookup_key stringrequired

    A provided lookup key provided by you to help you identify the theme.

    created_at stringrequired

    UTC datetime ISO string

    updated_at stringrequired

    UTC datetime ISO string

Loading...