# Organization API

The Organization API allows you to retrieve your tenant's organization details.

Required Scope: read:organization

# Endpoints

Method	Endpoint	Description
GET	`/organization`	Get organization details

# Get Organization

Retrieve the organization details for your tenant.

GET /organization

# Query Parameters

Parameter	Type	Required	Description
`client_id`	string	Yes	Your developer client ID
`client_secret`	string	Yes	Your developer client secret
`grant_type`	string	Yes	Must be `client_credentials`

# Request Example

curl -X GET 'https://api.admin.novti.io/organization?client_id=YOUR_CLIENT_ID&client_secret=YOUR_CLIENT_SECRET&grant_type=client_credentials'

# Response

Success (200 OK)

{
  "status": "Success",
  "data": {
    "id": "org123",
    "name": "Acme Corporation",
    "slug": "acme-corp",
    "description": "Leading provider of innovative solutions",
    "contact": {
      "email": "contact@acme.com",
      "phone": "+1 (555) 123-4567",
      "address": {
        "street": "123 Main St",
        "city": "New York",
        "state": "NY",
        "zip": "10001",
        "country": "USA"
      }
    },
    "branding": {
      "logo": "https://cdn.novti.io/logos/acme.png",
      "primaryColor": "#0066CC",
      "secondaryColor": "#FF6600"
    },
    "settings": {
      "timezone": "America/New_York",
      "language": "en-US"
    },
    "createdAt": "2023-01-10T08:00:00Z",
    "updatedAt": "2024-03-15T16:45:00Z"
  },
  "meta": {
    "size": 1
  }
}

# Organization Object

Field	Type	Description
`id`	string	Unique identifier for the organization
`name`	string	Organization display name
`slug`	string	URL-friendly identifier
`description`	string	Organization description
`contact`	object	Contact information
`branding`	object	Branding assets and colors
`settings`	object	Organization settings
`createdAt`	string (ISO 8601)	Creation timestamp
`updatedAt`	string (ISO 8601)	Last update timestamp

# Contact Object

Field	Type	Description
`email`	string	Primary contact email
`phone`	string	Contact phone number
`address`	object	Physical address

# Address Object

Field	Type	Description
`street`	string	Street address
`city`	string	City name
`state`	string	State or province
`zip`	string	Postal code
`country`	string	Country code

# Branding Object

Field	Type	Description
`logo`	string	URL to organization logo
`primaryColor`	string	Primary brand color (hex)
`secondaryColor`	string	Secondary brand color (hex)

# Settings Object

Field	Type	Description
`timezone`	string	Organization timezone
`language`	string	Default language code

# See Also

← Forms API