List plan requests

get

https://tenants-gateway-api-sbx.sidedrawersbx.com/api/v2/tenants/tenant/tenant-id/{tenantId}/plans/plan-requests

Path Params

tenantId

string

required

Tenant identifier.

Query Params

limit

string

Limit. Default value is 20.

startingAfter

string

Starting after is an object ID that defines your place in the list.

endingBefore

string

Object identifier that defines your place in the list.

externalKey

string

External Key.

externalKeyValue

string

External Key Value.

region

string

Region.

openDaysFrom

number

Open days from range.

openDaysTo

number

Open days to range.

status

string

enum

Current status of the action execution.

Allowed:

sortBy

string

enum

Sort response by field (default: "requestId").

Allowed:

orderBy

string

enum

Sort response order (default: "desc").

Allowed:

locale

string

enum

Locale in [ISO 639-1]-[ISO 3166-1] format.

Allowed:

tags

tagLogicalOperator

string

enum

Tags logical operator (default: 'AND').

Allowed:

excludeTags

array of strings

Tags to exclude.

excludeTags

Response

Language

Credentials

Bearer

JWT

Loading…

Response

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

application/json

200The given Plan requests.