Read organization

GET /organization/information
Tfso

Read information about the organization that the current profile is logged into.

24SevenOffice is a multi-tenant application, where a personal login gives access to more than one organization and its people.

Hence, there exist "identity", "organization" and the organization’s "people".

Identity → *Organization → *Person


Organization An organization is usually a legal entity based in a certain country. An organization will own all of its data such as customers, invoices, transactions, etc. An organization will have many people that may be employees, connections, etc.

Headers

  • Authorization string Required

    Authorization header

Responses

  • 200 application/json

    Success

    Hide headers attributes Show headers attributes
    • Access-Control-Allow-Origin string
    • Access-Control-Allow-Credentials string
    • X-Trace-Id string
    Hide response attributes Show response attributes object
    • id integer(int64)

      The unique identifier for the organization within 24SevenOffice.

    • name string | null

      The name of the organization.

    • email string | null

      The email address of the organization.

    • invoiceEmail string | null

      The email address for invoices.

    • address object

      The address of the organization.

      Additional properties are NOT allowed.

      Hide address attributes Show address attributes object
      • street string | null

        The street for the address. Can contain a street name, building and apartment number, a PO box number, or similar.

      • city string | null

        The city for the address.

      • postalArea string | null

        The postal area for the address.

      • postalCode string | null

        The postal code for the address.

      • countrySubdivision string | null

        The geographical subdivision for the address, like a county ("fylke" in Norway) or a state.

      • countryCode string | null

        The two-letter country code for the address, as in ISO 3166-1 alpha-2 standard.

    • status string

      The state of the organization.

      Values are Unknown, Inactive, or Active.

    • settings object

      Settings for the organization.

      Additional properties are NOT allowed.

      Hide settings attribute Show settings attribute object
      • currencyCode string | null

        The currency code for the organization.

    • contact object

      Contact information for the organization.

      Additional properties are NOT allowed.

      Hide contact attributes Show contact attributes object
      • name string | null

        The name of the organization's contact person.

      • phone string | null

        The phone number for contacting the organization's contact person.

      • email string | null

        The email address for contacting the organization's contact person.

      • language string | null

        The contact person's language setting.
GET /organization/information 
curl \
 --request GET 'https://rest.api.24sevenoffice.com/v1/organization/information' \
 --header "Authorization: string"
Response examples (200) 
{
  "id": 12345,
  "name": "ABC Corporation",
  "email": "contact@example.com",
  "status": "Active",
  "address": {
    "city": "Baerum",
    "street": "Hovedgata 1",
    "postalArea": "Fornebu",
    "postalCode": "0123",
    "countryCode": "NO",
    "countrySubdivision": "Viken"
  },
  "contact": {
    "name": "John Doe",
    "email": "john.doe@example.com",
    "phone": "+47-87654321",
    "language": "en"
  },
  "settings": {
    "currencyCode": "NOK"
  },
  "invoiceEmail": "invoices@example.com"
}