Skip to content

/v2/background-scripts/
Stable

Request

Retrieve all background scripts for the tenant

Query
orderingstring

Order the results by a specific field (-field for descending order). Valid fields are 'name', 'created_at', 'updated_at', 'created_by', 'updated_by'.

namestring

Filter the results by name (partial match, case insensitive).

always_runboolean

Filter the results by always_run flag.

limitinteger, [ 1 .. 100 ]

Number of results to return per page.

Default:10
offsetinteger, >= 0

The initial index from which to return the results.

Default:0
cURL
curl -i -X GET \
  'https://api.esper.io/_mock/openapi/v2/background-scripts/?ordering=string&name=string&always_run=true&limit=10&offset=0'

Responses

Success

Bodyapplication/json
contentobject
messagestring
codeinteger
Response
{
  "content": {
    "count": 0,
    "next": "string",
    "previous": "string",
    "results": [ … ]
  },
  "message": "string",
  "code": 0
}