List available layouts

get

https://rls.congacloud.com/api/sign/v1/cs-layouts

Retrieves a list of available layouts, which you can filter and sort. By default, this call returns the API caller's layouts. When specifying either the ownerUserId or ownerEmail query parameter, this call returns the specified user's layouts. To retrieve other users' layouts, you must have enabled the roles and permissions feature on your account and the API caller must have the "Manage users’ transactions, templates, and layouts" permission. To enable roles and permissions, contact your Conga Sign sales representative.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

query

string

The folder to search for. If not set, it will search in all folders.

type

string

If a template is needed, set to TEMPLATE.

string

Any text which is going to be used in conjunction with the searchtype, if provided.

searchType

string

When empty, a wildcard search will be done in the layout name and description for the search value, otherwise the allowable values will make more restrictive searches. Available values : exact, exactname

visibility

string

The visibility used to search for the layout. Available values : ACCOUNT, SENDER

from

int32

The first record that will be returned. Useful for pagination.

int32

The last record that will be returned. Useful for pagination.

dir

string

The direction according to which the data will be sorted. 'asc' for ascending and 'desc' for descending. Available values : asc, desc

sort

string

The field according to which the data will be sorted. Available values : created, updated, name

summary

boolean

If set to true, the response contains just a summary of the layouts. Otherwise, the response contains the full objects.

ownerUserId

string

The transaction owner user's ID. Indicate the target user to search on.

ownerEmail

string

The transaction owner's email address. Indicate the target user to search on.

Responses

200OK

401Not Authorized

500Unexpected Error