Skip to main content
GET
/
settings
/
company
Get Company Settings
curl --request GET \
  --url https://api.getoutbox.ai/settings/company \
  --header 'Authorization: <api-key>'
{
  "id": "<string>",
  "name": "<string>",
  "email": "<string>",
  "logo": "<string>",
  "address": {
    "address": "<string>",
    "city": "<string>",
    "state": "<string>",
    "country": "<string>",
    "zip_code": "<string>"
  },
  "api_key": "<string>",
  "staff": [
    {
      "id": "<string>",
      "full_name": "<string>",
      "email": "<string>",
      "role": 2
    }
  ],
  "invites": [
    {
      "id": "<string>",
      "email": "<string>",
      "role": 2
    }
  ]
}

Authorizations

Authorization
string
header
required

Company API Key

Response

Company settings retrieved successfully

id
string
name
string
email
string
logo
string | null

Logo URL, null if not set

address
object
api_key
string
staff
object[]
invites
object[]