• Free Trial
  • Products
    • LMSThe world’s easiest-to-use learning management system.
    • Training ContentA robust library of off-the-shelf learning content.
  • Solutions
    • By Use Case
      • Employee Training
      • Sales Training
      • Customer Training
      • Partner Training
      • Compliance Training
      • View all
    • By Industry
      • Technology
      • Nonprofit
      • Retail
      • Hospitality
      • Healthcare
      • View all
  • Customers
    • Learn more about Litmos customer success stories.
      • Case Studies
      • Video Testimonials
      • I Love Litmos
      • Lenny Awards
    • Featured Customer
      • Sabre, a global travel technology provider, increases revenue by using Litmos to train their sales and technical teams.
  • Pricing
  • Resources
    • Ebooks & Infographics
    • Webinars & Podcasts
    • Events
    • Integrations
    • Blog
  • About
    • Company
    • Partners
    • Awards
    • Careers
    • Sustainability
  • Free Trial
Litmos
Log in
Contact us
Support
Search
  • Free Trial
  • Products
    • LMSThe world’s easiest-to-use learning management system.
    • Training ContentA robust library of off-the-shelf learning content.
  • Solutions
    • By Use Case
      • Employee Training
      • Sales Training
      • Customer Training
      • Partner Training
      • Compliance Training
      • View all
    • By Industry
      • Technology
      • Nonprofit
      • Retail
      • Hospitality
      • Healthcare
      • View all
  • Customers
    • Learn more about Litmos customer success stories.
      • Case Studies
      • Video Testimonials
      • I Love Litmos
      • Lenny Awards
    • Featured Customer
      • Sabre, a global travel technology provider, increases revenue by using Litmos to train their sales and technical teams.
  • Pricing
  • Resources
    • Ebooks & Infographics
    • Webinars & Podcasts
    • Events
    • Integrations
    • Blog
  • About
    • Company
    • Partners
    • Awards
    • Careers
    • Sustainability
  • Free Trial

Litmos Training Operations Documentation

APIs

Home › Litmos Training Operations Documentation › LTO REST API: Organization (Get, Create, Update, Delete)

LTO REST API: Organization (Get, Create, Update, Delete)

Organization API (Get, Create, Update & Delete)

Returns a list of Organizations in your company including active and inactive organizations. By default, all the Organizations are returned. The list can be filtered on ID, Organization Key and External Organization ID.

Note: All requests must be Authenticated.

Authentication and Authorization:

Information used for API authentication and authorization is submitted in the request header. The following header name/values are required with each request.

Header Description
CompanyLoginId Company Login Id (provisioned by ViewCentral account management)
ProductId Product Id. 1=Learning Management, 2=Event Management
Username User account username
Password User account password

Get organization list:

Returns a list of all Organizations in company

Request Uri: GET  https://api.viewcentral.com/api/organizations

Response Codes:

HTTP Status Description
200 Operation successful. Organizations object returned in response
400 Operation not successful. Response contains error information
404 Operation not successful. Organizations object not found

Response Example:

{
  "Success": true,
  "Error": null,
  "Data": [
    {
      "Id": "Int [max length 4]",
      "Key": "string [max length 100]",
      "Name": "string [max length 210]",
      "Type": "string [max length 50]",
      "ExternalId": "string [max length 50]",
      "Active": "Bool",
      "City": "string [max length 200]",
      "Country": "string[max length 2, See Country list*]",
      "PostalCode": "string [max length 40]",
      "Street1": "string [max length 200]",
      "Street2": "string [max length 200]",
      "Phone": "string [max length 50]",
      "StateProvince": "string [max length 2, See State list*]",
      "AccountingCode": "string [max length 50]",
      "Comments": "string [max length 1024]",
      "CustomDetail1": "string [max length 200]",
      "CustomDetail2": "string [max length 200]",
      "CustomDetail3": "string [max length 200]",
      "CustomDetail4": "string [max length 200]",
      "CustomDetail5": "string [max length 200]",
      "CustomDetail6": "string [max length 200]",
      "CustomDetail7": "string [max length 200]",
      "CustomDetail8": "string [max length 200]",
      "TaxExemptId": "string [max length 50]",
      "IsTaxExempt": "Bool",
      "NotificationToSuperUser": "Bool",
      "Modified": {
        "CreatedBy": "string [max length 50]",
        "CreatedDate": "datetime [yyyy-mm-ddThh:mm:ssZ]",
        "UpdatedBy": "string [max length 50]",
        "UpdatedDate": "datetime [yyyy-mm-ddThh:mm:ssZ]"
      },
      "Links": [
        {
          "Rel": "Self",
          "Href": "/organizations/{orgid}",
          "Method": "GET"
        },
        {
          "Rel": "AttendeeGroups",
          "Href": "/organizations/{orgid}/attendee_groups",
          "Method": "GET"
        },
        {
          "Rel": "EmailDomains",
          "Href": "/organizations/{orgid}/emaildomains",
          "Method": "GET"
        }
      ]
    }
  ]
}

* See country list.

* See state list.

Get single organization:

Returns a single organization details for the given organization Id.

Request Uri: GET  https://api.viewcentral.com/api/organizations/{ID}

Response Codes:

HTTP Status Description
200 Operation successful. Organizations object returned in response
400 Operation not successful. Response contains error information
404 Operation not successful. Organizations object not found

Get organizations based on filters:

Returns a list of organizations based on selected filters.

Request Uri: GET  https://api.viewcentral.com/api/organizations?key=&ExternalId=

Request Filters

Sl.No Key Value
1 key string [max length 100]
2 ExternalId string [max length 50]

Response Example:

Click here to see the single response of ‘Organization’

Create Organization:

Creates organization via Litmos Commerce API. (Provide agreement company object in request body).

Note: All requests must be Authenticated.

Authentication and Authorization

 

Information used for API authentication and authorization is submitted in the request header. The following header name/values are required with each request.

Header Description
CompanyLoginId Company Login Id (provisioned by ViewCentral account management)
ProductId Product Id. 1=Learning Management, 2=Event Management
Username User account username
Password User account password

Request: Provide created organization object in request body

URI : POST  https://api.viewcentral.com/api/organizations

Request Example :

{
  "Key": " Required string [max length 100]",
  "Name": "Required string [max length 210]",
  "Type": "Optional string [max length 50]",
  "ExternalId": "Optional string [max length 50]",
  "Active": "Bool",
  "City": "Optional string [max length 200]",
  "Country": "Optional string [max length 2, See Country list*]",
  "PostalCode": "Optional string [max length 40]",
  "Street1": "Optional string [max length 200]",
  "Street2": "Optional string [max length 200]",
  "Phone": "Optional string [max length 50]",
  "StateProvince": "Optional string [max length 2, See State list*]",
  "AccountingCode": "Optional string [max length 50]",
  "Comments": "Optional string [max length 1024]",
  "CustomDetail1": "Optional string [max length 1024]",
  "CustomDetail2": "Optional string [max length 1024]",
  "CustomDetail3": "Optional string [max length 1024]",
  "CustomDetail4": "Optional string [max length 1024]",
  "CustomDetail5": "Optional string [max length 1024]",
  "CustomDetail6": "Optional string [max length 1024]",
  "CustomDetail7": "Optional string [max length 1024]",
  "CustomDetail8": "Optional string [max length 1024]",
  "TaxExemptId": "Optional string [max length 1024]",
  "IsTaxExempt": "Bool [Optional]",
  "NotificationToSuperUser": "Bool [Optional]"
}

* See country list.

* See state list.

Response Codes :

Returns the organization object created with organization id

HTTP Status Description
201 Operation successful. Organization object created. Newly created object is returned in response
400 Operation not successful. Organization object not created. Response contains error information

 

Response Example:

Click here to see the single response of ‘Organization’

 

Update Organization :

Update organization by organization id via Litmos Commerce API.

Note: All requests must be Authenticated.

Authentication and Authorization

Information used for API authentication and authorization is submitted in the request header. The following header name/values are required with each request.

Header Description
CompanyLoginId Company Login Id (provisioned by ViewCentral account management)
ProductId Product Id. 1=Learning Management, 2=Event Management
Username User account username
Password User account password

Request : Provide updated organization object in request body.

URI : PUT https://api.viewcentral.com/api/organizations/{org ID}

NOTE: this operation supports complete object update only – partial object update is NOT supported at this time. If the API request data does not supply ALL properties/fields with their intended values, the fields not supplied will be assigned the default value: NULL. If record previously had data in this field, the value will now be set to NULL.  For example, an agreement company record is added with the Street2 set to “Suite 1”. With the API (PUT action) to update, if the organization.Street2 property is not supplied in the API request, the street2 value will be set to NULL

Request example:

{
  "Key": " Required string [max length 100]",
  "Name": "Required string [max length 210]",
  "Type": "Optional string [max length 50]",
  "ExternalId": "Optional string [max length 50]",
  "Active": "Bool",
  "City": "Optional string [max length 200]",
  "Country": "Optional string [max length 2, See Country list*]",
  "PostalCode": "Optional string [max length 40]",
  "Street1": "Optional string [max length 200]",
  "Street2": "Optional string [max length 200]",
  "Phone": "Optional string [max length 50]",
  "StateProvince": "Optional string [max length 2, See State list*]",
  "AccountingCode": "Optional string [max length 50]",
  "Comments": "Optional string [max length 1024]",
  "CustomDetail1": "Optional string [max length 1024]",
  "CustomDetail2": "Optional string [max length 1024]",
  "CustomDetail3": "Optional string [max length 1024]",
  "CustomDetail4": "Optional string [max length 1024]",
  "CustomDetail5": "Optional string [max length 1024]",
  "CustomDetail6": "Optional string [max length 1024]",
  "CustomDetail7": "Optional string [max length 1024]",
  "CustomDetail8": "Optional string [max length 1024]",
  "TaxExemptId": "Optional string [max length 1024]",
  "IsTaxExempt": "Bool [Optional]",
  "NotificationToSuperUser": "Bool [Optional]"
}

* See country list.

* See state list.

Response Codes:

HTTP Status Description
200 Operation successful. Organizations object returned in response
400 Operation not successful. Response contains error information
404 Operation not successful. Organizations object not found

Response Example:

Check Get Organization API for response details/format.

 

Delete Organization :

Delete the organization by ID via Litmos Commerce API.

Note: All requests must be Authenticated.

Authentication and Authorization

nformation used for API authentication and authorization is submitted in the request header. The following header name/values are required with each request.

Header Description
CompanyLoginId Company Login Id (provisioned by ViewCentral account management)
ProductId Product Id. 1=Learning Management, 2=Event Management
Username User account username
Password User account password

Request : Organization ID to be deleted provided in endpoint

URI : DEL /api/organization/{Organization ID}

Response Codes:

HTTP Status Description
200 Operation successful. Organizations object returned in response
400 Operation not successful. Response contains error information
404 Operation not successful. Organizations object not found

No part of this publication may be reproduced or transmitted in any form or for any purpose without the express permission of Litmos.

The information contained herein may be changed without prior notice. Some software products marketed by Litmos and its distributors contain proprietary software components of other software vendors. National product specifications may vary.

These materials are provided by Litmos for informational purposes only, without representation or warranty of any kind, and Litmos or its affiliated companies shall not be liable for errors or omissions with respect to the materials. The only warranties for Litmos company products and services are those that are set forth in the express warranty statements accompanying such products and services, if any. Nothing herein should be construed as constituting an additional warranty.

In particular Litmos or its affiliated companies have no obligation to pursue any course of business outlined in this document or any related presentation, or to develop or release any functionality mentioned therein. This document, or any related presentation, and Litmos or its affiliated companies’ strategy and possible future developments, products, and/or platform directions and functionality are all subject to change and may be changed by Litmos or its affiliated companies at any time for any reason without notice.

The information in this document is not a commitment, promise, or legal obligation to deliver any material, code, or functionality. All forward-looking statements are subject to various risks and uncertainties that could cause actual results to differ materially from expectations. Readers are cautioned not to place undue reliance on these forward-looking statements, and they should not be relied upon in making purchasing decisions.

© 2022 Litmos or a Litmos affiliate company. All rights reserved.

Litmos and other Litmos products and services mentioned herein as well as their respective logos are trademarks or registered trademarks of Litmos (or a Litmos affiliate company) in the United States and other countries. All other product and service names mentioned are the trademarks of their respective companies.

Match keywords.

Useful Links

  • Release Notes
  • Customer Portal

In this article

Related articles

  1. LTO REST API: Attendee (Get Create, Update, Delete)
  2. LTO REST API: Location (Get, Create, Update)
  3. LTO REST API: Vendor (Get, Create, Update)

Also of Interest

  • Corporate Training Software
  • Enterprise Learning Strategy
  • Online Training Courses
  • Corporate LMS
  • Enterprise Learning Management System
  • LMS Platform
  • eLearning Platform
  • What is a learning management system?
  • See Additional Resources

Solutions by Use Case

  • Employee Training
  • Customer Training
  • Compliance Training
  • Sales Training
  • Operations Training
  • Gig Worker Training
  • Contractor Training
  • Supplier Training

Solutions by Industry

  • Technology
  • Nonprofit
  • Retail
  • Hospitality
  • Healthcare

Contact Us

Contact
UK: +44 20 4551 1606
USA: +1 925 490 0401
AUS: +61 3 7066 4851
Email
Support
Address
Contact Us
Litmos Reviews Litmos Reviews
Litmos Careers Careers

© 2023 Litmos US, L.P. and affiliates. All rights reserved.

  • Privacy Statement
  • Terms & Conditions
  • Website Terms