SCOPE

All Scopes

get

https://api.example.comhttps://staging-api.example.com

/api/v1/scope/

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Responses

200

Successful response

application/json

get

/api/v1/scope/

HTTPcURLJavaScriptPython

GET /api/v1/scope/ HTTP/1.1
Host: api.example.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

Successful response

No content

Create Scope

post

https://api.example.comhttps://staging-api.example.com

/api/v1/scope/

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

objectOptionalExample: {"prefix":"example","slug":"demo-scope","description":"Demo scope description","organizationId":9}

Responses

200

Successful response

application/json

post

/api/v1/scope/

HTTPcURLJavaScriptPython

POST /api/v1/scope/ HTTP/1.1
Host: api.example.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 98

{
  "prefix": "example",
  "slug": "demo-scope",
  "description": "Demo scope description",
  "organizationId": 9
}

200

Successful response

No content

Single Scope

get

https://api.example.comhttps://staging-api.example.com

/api/v1/scope/{scopeId}

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

scopeIdintegerRequiredExample: 1

Responses

200

Successful response

application/json

get

/api/v1/scope/{scopeId}

HTTPcURLJavaScriptPython

GET /api/v1/scope/{scopeId} HTTP/1.1
Host: api.example.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

Successful response

No content

Edit Single Scope

put

https://api.example.comhttps://staging-api.example.com

/api/v1/scope/{scopeId}

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

scopeIdintegerRequiredExample: 2

Body

application/json

objectOptionalExample: {"prefix":"UPDATED","slug":"updated-scope","description":"Updated scope description","organizationId":1}

Responses

200

Successful response

application/json

put

/api/v1/scope/{scopeId}

HTTPcURLJavaScriptPython

PUT /api/v1/scope/{scopeId} HTTP/1.1
Host: api.example.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 104

{
  "prefix": "UPDATED",
  "slug": "updated-scope",
  "description": "Updated scope description",
  "organizationId": 1
}

200

Successful response

No content

Single Scope - Intents

get

https://api.example.comhttps://staging-api.example.com

/api/v1/scope/{scopeId}/intents

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

scopeIdintegerRequiredExample: 1

Responses

200

Successful response

application/json

get

/api/v1/scope/{scopeId}/intents

HTTPcURLJavaScriptPython

GET /api/v1/scope/{scopeId}/intents HTTP/1.1
Host: api.example.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

Successful response

No content

Single Scope - Intents - Most Used

get

https://api.example.comhttps://staging-api.example.com

/api/v1/scope/{scopeId}/intents/most-used

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

scopeIdintegerRequiredExample: 1

Responses

200

Successful response

application/json

get

/api/v1/scope/{scopeId}/intents/most-used

HTTPcURLJavaScriptPython

GET /api/v1/scope/{scopeId}/intents/most-used HTTP/1.1
Host: api.example.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

Successful response

No content

Single Scope - Channels

get

https://api.example.comhttps://staging-api.example.com

/api/v1/scope/{scopeId}/channels

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

scopeIdintegerRequiredExample: 1

Responses

200

Successful response

application/json

get

/api/v1/scope/{scopeId}/channels

HTTPcURLJavaScriptPython

GET /api/v1/scope/{scopeId}/channels HTTP/1.1
Host: api.example.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

Successful response

No content

Single Scope - DIMS

get

https://api.example.comhttps://staging-api.example.com

/api/v1/scope/{scopeId}/dims

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

scopeIdintegerRequiredExample: 1

Responses

200

Successful response

application/json

get

/api/v1/scope/{scopeId}/dims

HTTPcURLJavaScriptPython

GET /api/v1/scope/{scopeId}/dims HTTP/1.1
Host: api.example.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

Successful response

No content

Single Scope - Toggle debug

post

https://api.example.comhttps://staging-api.example.com

/api/v1/scope/{scopeId}/toggle-debug

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

scopeIdintegerRequiredExample: 1

Body

Responses

200

Successful response

application/json

post

/api/v1/scope/{scopeId}/toggle-debug

HTTPcURLJavaScriptPython

POST /api/v1/scope/{scopeId}/toggle-debug HTTP/1.1
Host: api.example.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

Successful response

No content

Delete Scope

delete

https://api.example.comhttps://staging-api.example.com

/api/v1/scope/{scopeId}/delete

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

scopeIdintegerRequiredExample: 2

Responses

200

Successful response

application/json

delete

/api/v1/scope/{scopeId}/delete

HTTPcURLJavaScriptPython

DELETE /api/v1/scope/{scopeId}/delete HTTP/1.1
Host: api.example.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

Successful response

No content

Single Scope - All Channels Down

get

https://api.example.comhttps://staging-api.example.com

/api/v1/scope/{scopeId}/channels/down

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

scopeIdintegerRequiredExample: 2

Responses

200

Successful response

application/json

get

/api/v1/scope/{scopeId}/channels/down

HTTPcURLJavaScriptPython

GET /api/v1/scope/{scopeId}/channels/down HTTP/1.1
Host: api.example.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

Successful response

No content

Single Scope - All Channels Up

get

https://api.example.comhttps://staging-api.example.com

/api/v1/scope/{scopeId}/channels/up

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

scopeIdintegerRequiredExample: 2

Responses

200

Successful response

application/json

get

/api/v1/scope/{scopeId}/channels/up

HTTPcURLJavaScriptPython

GET /api/v1/scope/{scopeId}/channels/up HTTP/1.1
Host: api.example.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

Successful response

No content