Settings API

Settings management endpoints

Auto-generated from OpenAPI spec on 2025-10-02

GET /settings/profile

GET profile

🔒 Authentication Required: Bearer token

Parameters

Name	Type	Required	Description
`orgId`	query	Yes	Organization ID

Responses

200 - Successful response

{}

400 - Bad request

{
  "error": "string",
  "message": "string",
  "code": "string",
  "statusCode": 0
}

401 - Unauthorized

{
  "error": "string",
  "message": "string",
  "code": "string",
  "statusCode": 0
}

404 - Not found

{
  "error": "string",
  "message": "string",
  "code": "string",
  "statusCode": 0
}

Examples

curl -X GET https://api.syaala.com/settings/profile \\
  -H "Authorization: Bearer ${SYAALA_API_KEY}" \\
  -H "Content-Type: application/json"

const response = await fetch('https://api.syaala.com/settings/profile', {
  method: 'GET',
  headers: {
    'Authorization': `Bearer ${process.env.SYAALA_API_KEY}`,
    'Content-Type': 'application/json'
  }
})
 
const data = await response.json()

import os
import requests
 
response = requests.get(
    'https://api.syaala.com/settings/profile',
    headers={
        'Authorization': f'Bearer {os.environ["SYAALA_API_KEY"]}',
        'Content-Type': 'application/json'
    }
)
 
data = response.json()

POST /settings/profile

POST profile

🔒 Authentication Required: Bearer token

Request Body

{}

Responses

200 - Successful response

{}

400 - Bad request

{
  "error": "string",
  "message": "string",
  "code": "string",
  "statusCode": 0
}

401 - Unauthorized

{
  "error": "string",
  "message": "string",
  "code": "string",
  "statusCode": 0
}

404 - Not found

{
  "error": "string",
  "message": "string",
  "code": "string",
  "statusCode": 0
}

Examples

curl -X POST https://api.syaala.com/settings/profile \\
  -H "Authorization: Bearer ${SYAALA_API_KEY}" \\
  -H "Content-Type: application/json" \\
  -d '{}'

const response = await fetch('https://api.syaala.com/settings/profile', {
  method: 'POST',
  headers: {
    'Authorization': `Bearer ${process.env.SYAALA_API_KEY}`,
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({})
})
 
const data = await response.json()

import os
import requests
 
response = requests.post(
    'https://api.syaala.com/settings/profile',
    headers={
        'Authorization': f'Bearer {os.environ["SYAALA_API_KEY"]}',
        'Content-Type': 'application/json'
    },
    json={}
)
 
data = response.json()

GET /settings/api-keys

GET api-keys

🔒 Authentication Required: Bearer token

Parameters

Name	Type	Required	Description
`orgId`	query	Yes	Organization ID

Responses

200 - Successful response

{}

400 - Bad request

{
  "error": "string",
  "message": "string",
  "code": "string",
  "statusCode": 0
}

401 - Unauthorized

{
  "error": "string",
  "message": "string",
  "code": "string",
  "statusCode": 0
}

404 - Not found

{
  "error": "string",
  "message": "string",
  "code": "string",
  "statusCode": 0
}

Examples

curl -X GET https://api.syaala.com/settings/api-keys \\
  -H "Authorization: Bearer ${SYAALA_API_KEY}" \\
  -H "Content-Type: application/json"

const response = await fetch('https://api.syaala.com/settings/api-keys', {
  method: 'GET',
  headers: {
    'Authorization': `Bearer ${process.env.SYAALA_API_KEY}`,
    'Content-Type': 'application/json'
  }
})
 
const data = await response.json()

import os
import requests
 
response = requests.get(
    'https://api.syaala.com/settings/api-keys',
    headers={
        'Authorization': f'Bearer {os.environ["SYAALA_API_KEY"]}',
        'Content-Type': 'application/json'
    }
)
 
data = response.json()

POST /settings/api-keys

POST api-keys

🔒 Authentication Required: Bearer token

Request Body

{}

Responses

200 - Successful response

{}

400 - Bad request

{
  "error": "string",
  "message": "string",
  "code": "string",
  "statusCode": 0
}

401 - Unauthorized

{
  "error": "string",
  "message": "string",
  "code": "string",
  "statusCode": 0
}

404 - Not found

{
  "error": "string",
  "message": "string",
  "code": "string",
  "statusCode": 0
}

Examples

curl -X POST https://api.syaala.com/settings/api-keys \\
  -H "Authorization: Bearer ${SYAALA_API_KEY}" \\
  -H "Content-Type: application/json" \\
  -d '{}'

const response = await fetch('https://api.syaala.com/settings/api-keys', {
  method: 'POST',
  headers: {
    'Authorization': `Bearer ${process.env.SYAALA_API_KEY}`,
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({})
})
 
const data = await response.json()

import os
import requests
 
response = requests.post(
    'https://api.syaala.com/settings/api-keys',
    headers={
        'Authorization': f'Bearer {os.environ["SYAALA_API_KEY"]}',
        'Content-Type': 'application/json'
    },
    json={}
)
 
data = response.json()

PUT /settings/api-keys

PUT api-keys

🔒 Authentication Required: Bearer token

Request Body

{}

Responses

200 - Successful response

{}

400 - Bad request

{
  "error": "string",
  "message": "string",
  "code": "string",
  "statusCode": 0
}

401 - Unauthorized

{
  "error": "string",
  "message": "string",
  "code": "string",
  "statusCode": 0
}

404 - Not found

{
  "error": "string",
  "message": "string",
  "code": "string",
  "statusCode": 0
}

Examples

curl -X PUT https://api.syaala.com/settings/api-keys \\
  -H "Authorization: Bearer ${SYAALA_API_KEY}" \\
  -H "Content-Type: application/json" \\
  -d '{}'

const response = await fetch('https://api.syaala.com/settings/api-keys', {
  method: 'PUT',
  headers: {
    'Authorization': `Bearer ${process.env.SYAALA_API_KEY}`,
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({})
})
 
const data = await response.json()

import os
import requests
 
response = requests.put(
    'https://api.syaala.com/settings/api-keys',
    headers={
        'Authorization': f'Bearer {os.environ["SYAALA_API_KEY"]}',
        'Content-Type': 'application/json'
    },
    json={}
)
 
data = response.json()

PATCH /settings/api-keys

PATCH api-keys

🔒 Authentication Required: Bearer token

Request Body

{}

Responses

200 - Successful response

{}

400 - Bad request

{
  "error": "string",
  "message": "string",
  "code": "string",
  "statusCode": 0
}

401 - Unauthorized

{
  "error": "string",
  "message": "string",
  "code": "string",
  "statusCode": 0
}

404 - Not found

{
  "error": "string",
  "message": "string",
  "code": "string",
  "statusCode": 0
}

Examples

curl -X PATCH https://api.syaala.com/settings/api-keys \\
  -H "Authorization: Bearer ${SYAALA_API_KEY}" \\
  -H "Content-Type: application/json" \\
  -d '{}'

const response = await fetch('https://api.syaala.com/settings/api-keys', {
  method: 'PATCH',
  headers: {
    'Authorization': `Bearer ${process.env.SYAALA_API_KEY}`,
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({})
})
 
const data = await response.json()

import os
import requests
 
response = requests.patch(
    'https://api.syaala.com/settings/api-keys',
    headers={
        'Authorization': f'Bearer {os.environ["SYAALA_API_KEY"]}',
        'Content-Type': 'application/json'
    },
    json={}
)
 
data = response.json()

DELETE /settings/api-keys

DELETE api-keys

🔒 Authentication Required: Bearer token

Responses

200 - Successful response

{}

400 - Bad request

{
  "error": "string",
  "message": "string",
  "code": "string",
  "statusCode": 0
}

401 - Unauthorized

{
  "error": "string",
  "message": "string",
  "code": "string",
  "statusCode": 0
}

404 - Not found

{
  "error": "string",
  "message": "string",
  "code": "string",
  "statusCode": 0
}

Examples

curl -X DELETE https://api.syaala.com/settings/api-keys \\
  -H "Authorization: Bearer ${SYAALA_API_KEY}" \\
  -H "Content-Type: application/json"

const response = await fetch('https://api.syaala.com/settings/api-keys', {
  method: 'DELETE',
  headers: {
    'Authorization': `Bearer ${process.env.SYAALA_API_KEY}`,
    'Content-Type': 'application/json'
  }
})
 
const data = await response.json()

import os
import requests
 
response = requests.delete(
    'https://api.syaala.com/settings/api-keys',
    headers={
        'Authorization': f'Bearer {os.environ["SYAALA_API_KEY"]}',
        'Content-Type': 'application/json'
    }
)
 
data = response.json()

GET /settings/organization

GET organization

🔒 Authentication Required: Bearer token

Parameters

Name	Type	Required	Description
`orgId`	query	Yes	Organization ID

Responses

200 - Successful response

{}

400 - Bad request

{
  "error": "string",
  "message": "string",
  "code": "string",
  "statusCode": 0
}

401 - Unauthorized

{
  "error": "string",
  "message": "string",
  "code": "string",
  "statusCode": 0
}

404 - Not found

{
  "error": "string",
  "message": "string",
  "code": "string",
  "statusCode": 0
}

Examples

curl -X GET https://api.syaala.com/settings/organization \\
  -H "Authorization: Bearer ${SYAALA_API_KEY}" \\
  -H "Content-Type: application/json"

const response = await fetch('https://api.syaala.com/settings/organization', {
  method: 'GET',
  headers: {
    'Authorization': `Bearer ${process.env.SYAALA_API_KEY}`,
    'Content-Type': 'application/json'
  }
})
 
const data = await response.json()

import os
import requests
 
response = requests.get(
    'https://api.syaala.com/settings/organization',
    headers={
        'Authorization': f'Bearer {os.environ["SYAALA_API_KEY"]}',
        'Content-Type': 'application/json'
    }
)
 
data = response.json()

POST /settings/organization

POST organization

🔒 Authentication Required: Bearer token

Request Body

{}

Responses

200 - Successful response

{}

400 - Bad request

{
  "error": "string",
  "message": "string",
  "code": "string",
  "statusCode": 0
}

401 - Unauthorized

{
  "error": "string",
  "message": "string",
  "code": "string",
  "statusCode": 0
}

404 - Not found

{
  "error": "string",
  "message": "string",
  "code": "string",
  "statusCode": 0
}

Examples

curl -X POST https://api.syaala.com/settings/organization \\
  -H "Authorization: Bearer ${SYAALA_API_KEY}" \\
  -H "Content-Type: application/json" \\
  -d '{}'

const response = await fetch('https://api.syaala.com/settings/organization', {
  method: 'POST',
  headers: {
    'Authorization': `Bearer ${process.env.SYAALA_API_KEY}`,
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({})
})
 
const data = await response.json()

import os
import requests
 
response = requests.post(
    'https://api.syaala.com/settings/organization',
    headers={
        'Authorization': f'Bearer {os.environ["SYAALA_API_KEY"]}',
        'Content-Type': 'application/json'
    },
    json={}
)
 
data = response.json()

Secrets API Team API