Get a list of Dashboards.

get

https://cti.example.com/api/v2/dashboards

Required permissions

read dashboard

Query Params

limit

int32

≥ 1

Maximum number of items to be returned

offset

int32

≥ 0

Return results starting from the specified (zero-based) index

sort

string

Comma-separated list of fields to sort on. Prefix a field with the minus "-" sign if you intend to apply descending sorting to it

data

boolean

Set this parameter to false if you want to only retrieve the number of objects matching the query

attributes

string

Comma-separated list of attributes to be returned. Nested attributes are separated by dots - e.g. data.title

filter[name]

string

Filter dashboard by name

filter[is_pinned]

boolean

Filter dashboard to see only pinned ones

filter[created_by]

string

Filter dashboard by name

filter[last_updated_by]

boolean

Filter dashboard to see last user whop modified the data

filter[collaborators]

array of strings

Filter dashboard by user id to see all the shared users allowed to edit

filter[collaborators]

filter[groups]

array of strings

Filter dashboards by group id allowed to make edit

filter[groups]

Responses

Language

Credentials

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200The requested object(s)

400Invalid request

401Unauthorized request

403Missing permissions