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

Get, create, update and delete attendees through the Litmos Commerce API. Returns active and inactive people, filterable by ID and other fields.

Sep 26, 2026
Knowledge

Title

Last Updated

5/9/2023

URL Name

lto-rest-api-attendee-get-create-update-delete

Product

Training Ops

Body

Attendee API (Get , Create, Update & Delete)

Attendees - Get attendees

Returns list of Attendees in your company including active and inactive people.By default all the attendees are returned. The list can be filtered on ID, Last Name, Email , Company Name, OrganizationID and UniqueID.

Get Attendees List: Returns a list of all attendees in company

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 Uri: GET https://api.viewcentral.com/api/attendees/

Response Codes:

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

Response Example:

{
  "Success": "Bool",
  "Error": null,
  "Data": [
    {
      "Active": "Bool",
      "AlternativeEmail": "Optional string [max length 100]",
      "ApproverEmail": "Optional string [max length 256]",
      "BillToCity": "Optional string[max length 200]",
      "BillToCompany": "Optional string[max length 2048]",
      "BillToEmail": "Optional string [max length 256]",
      "BillToFax": "Optional string [max length 50]",
      "BillToFirstName": "Optional string [max length 200]",
      "BillToLastName": "Optional string [max length 200]",
      "BillToMiddleName": "Optional string [max length 200]",
      "BillToOtherState": "Optional string [max length 200]",
      "BillToPhone": "Optional string [max length 64]",
      "BillToPostalCode": "Optional string [max length 40]",
      "BillToStateProvince": "Optional string [max length 200, See State list]",
      "PostalCode": "Optional string [max length 40]",
      "BillToStreet1": "Optional string [max length 200]",
      "BillToStreet2": "Optional string [max length 200]",
      "BillToMobilePhone": "Optional string [max length 50]",
      "City": "Optional string[max length 200]",
      "Company": "Optional string[max length 2048]",
      "CustomId": "Optional string[max length 32]",
      "DefaultLookID": {
        "ID": "Optional  integer, [site branding list]"
      },
      "Department": "Optional string [max length 200]",
      "DoNotContact": "Optional int[max length 4]",
      "Country": "Optional string[max length 200, See Country list]",
      "Email": " Required string [max length 256]",
      "Fax": "Optional string [max length 50]",
      "FirstName": "Required string [max length 200]",
      "LastName": "Required string [max length 200]",
      "MiddleName": "Optional string [max length 100]",
      "NickName": "Optional string [max length 200]",
      "OtherStateProvince": "Optional string [max length 200]",
      "Phone": "Optional string [max length 64]",
      "Gender": "Optional string [max length 10, see Gender list]",
      "Salutation": "Optional string [max length 10, see Salutation list]",
      "StateProvince": "Optional string[max length 200, See State list]",
      "Street1": "Optional string[max length 200]",
      "Street2": "Optional string[max length 200]",
      "Title": "Optional [max length 256]",
      "Region": "Optional string[max length 100, See Attendee Region pull-down value list]",
      "Question1": "Optional int[max length 4]",
      "Question2": "Optional int[max length 4]",
      "Question3": "Optional int[max length 4]",
      "Question4": "Optional int[max length 4]",
      "Question5": "Optional int[max length 4]",
      "CustomDetail1": "Optional string[max length 200]",
      "CustomDetail2": "Optional string[max length 200]",
      "CustomDetail3": "Optional string[max length 200]",
      "CustomDetail4": "Optional string[max length 200]",
      "CustomDetail5": "Optional string[max length 200]",
      "UniqueID": "Optional string[max length 50]",
      "BillToCountry": "Optional string[max length 200, See Country list]",
      "BadgevillePlayerId": "Optional string[max length 30]",
      "CitizenshipCountry": "Optional string[max length 200, See Country list]",
      "EmployeeID": "Optional string[max length 20]",
      "IsManager": "Bool",
      "ManagerName": "Optional string, [Manager Name  list]",
      "ManagerID": "Optional int[max length 4]",
      "SuperUser": {
        "ID": "Optional integer"
      },
      "ID": "integer",
      "Organization": {
        "ID": "Optional integer"
      },
      "BillToOrganization": {
        "ID": "Optional integer"
      },
      "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": "/attendees/{id}",
          "Method": "GET"
        }
      ]
    }
  ]
}

Get Single Attendee:

Returns a single Attendee details for the given Attendee Id.

Request Uri:

GET https://api.viewcentral.com/api/attendees/{id}

Response Codes :

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

Get attendees using filters:

Request Uri:

GET api/attendees?LastName=&Email=&CompanyName=&OrganizationID=&UniqueID=

Request Filters

Sl.No	Key	Value
1	ID	Int [max length 4]
2	LastName	string [max length 200]
3	Email	string [max length 256]
4	CompanyName	string[max length 200]
5	OrganizationID	Integer
6	UniqueID	string[max length 50]

Response Codes:

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

Create Attendee:

Creates attendee via Litmos Commerce API. (Provide attendee 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 attendees object in request body

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

Request Example :

{
  "Active": "Bool",
  "AlternativeEmail": "Optional string [max length 100]",
  "ApproverEmail": "Optional string [max length 256]",
  "BillToCity": "Optional string[max length 200]",
  "BillToCompany": "Optional string[max length 2048]",
  "BillToEmail": "Optional string [max length 256]",
  "BillToFax": "Optional string [max length 50]",
  "BillToFirstName": "Optional string [max length 200]",
  "BillToLastName": "Optional string [max length 200]",
  "BillToMiddleName": "Optional string [max length 200]",
  "BillToOtherState": "Optional string [max length 200]",
  "BillToPhone": "Optional string [max length 64]",
  "BillToPostalCode": "Optional string [max length 40]",
  "BillToStateProvince": "Optional string [max length 200, See State list]",
  "PostalCode": "Optional string [max length 40]",
  "BillToStreet1": "Optional string [max length 200]",
  "BillToStreet2": "Optional string [max length 200]",
  "BillToMobilePhone": "Optional string [max length 50]",
  "City": "Optional string[max length 200]",
  "Company": "Optional string[max length 2048]",
  "CustomId": "Optional string[max length 32]",
  "DefaultLookID": {
    "ID": "Optional  integer, [site branding list]"
  },
  "Department": "Optional string [max length 200]",
  "DoNotContact": "Optional int[max length 4]",
  "Country": "Optional string[max length 200, See Country list]",
  "Email": " Required string [max length 256]",
  "Fax": "Optional string [max length 50]",
  "FirstName": "Required string [max length 200]",
  "LastName": "Required string [max length 200]",
  "MiddleName": "Optional string [max length 100]",
  "NickName": "Optional string [max length 200]",
  "OtherStateProvince": "Optional string [max length 200]",
  "Phone": "Optional string [max length 64]",
  "Gender": "Optional string [max length 10, see Gender list]",
  "Salutation": "Optional string [max length 10, see Salutation list]",
  "StateProvince": "Optional string[max length 200, See State list]",
  "Street1": "Optional string[max length 200]",
  "Street2": "Optional string[max length 200]",
  "Title": "Optional [max length 256]",
  "Region": "Optional string[max length 100, See Attendee Region pull-down value list]",
  "Question1": "Optional int[max length 4]",
  "Question2": "Optional int[max length 4]",
  "Question3": "Optional int[max length 4]",
  "Question4": "Optional int[max length 4]",
  "Question5": "Optional int[max length 4]",
  "CustomDetail1": "Optional string[max length 200]",
  "CustomDetail2": "Optional string[max length 200]",
  "CustomDetail3": "Optional string[max length 200]",
  "CustomDetail4": "Optional string[max length 200]",
  "CustomDetail5": "Optional string[max length 200]",
  "UniqueID": "Optional string[max length 50]",
  "BillToCountry": "Optional string[max length 200, See Country list]",
  "BadgevillePlayerId": "Optional string[max length 30]",
  "CitizenshipCountry": "Optional string[max length 200, See Country list]",
  "EmployeeID": "Optional string[max length 20]",
  "IsManager": "Bool",
  "ManagerName": "Optional string, [Manager Name  list]",
  "ManagerID": "Optional int[max length 4]",
  "SuperUser": {
    "ID": "Optional integer"
  },
  "Organization": {
    "ID": "Optional integer"
  },
  "BillToOrganization": {
    "ID": "Optional integer"
  }
}

Response Codes:

Returns the Attendee object created with Attendee id

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

Response Example:

Click here to see response of single Attendee API.

Update attendees :

Update attendees by attendee 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 attendees object in request body.

URI : PUT https://api.viewcentral.com/api/attendees/{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 attendees.Street2 property is not supplied in the API request, the street2 value will be set to NULL

Request example:

{
  "Active": "Bool",
  "AlternativeEmail": "Optional string [max length 100]",
  "ApproverEmail": "Optional string [max length 256]",
  "BillToCity": "Optional string[max length 200]",
  "BillToCompany": "Optional string[max length 2048]",
  "BillToEmail": "Optional string [max length 256]",
  "BillToFax": "Optional string [max length 50]",
  "BillToFirstName": "Optional string [max length 200]",
  "BillToLastName": "Optional string [max length 200]",
  "BillToMiddleName": "Optional string [max length 200]",
  "BillToOtherState": "Optional string [max length 200]",
  "BillToPhone": "Optional string [max length 64]",
  "BillToPostalCode": "Optional string [max length 40]",
  "BillToStateProvince": "Optional string [max length 200, See State list]",
  "PostalCode": "Optional string [max length 40]",
  "BillToStreet1": "Optional string [max length 200]",
  "BillToStreet2": "Optional string [max length 200]",
  "BillToMobilePhone": "Optional string [max length 50]",
  "City": "Optional string[max length 200]",
  "Company": "Optional string[max length 2048]",
  "CustomId": "Optional string[max length 32]",
  "DefaultLookID": {
    "ID": "Optional  integer, [site branding list]"
  },
  "Department": "Optional string [max length 200]",
  "DoNotContact": "Optional int[max length 4]",
  "Country": "Optional string[max length 200, See Country list]",
  "Email": "Required string [max length 256]",
  "Fax": "Optional string [max length 50]",
  "FirstName": "Required string [max length 200]",
  "LastName": "Required string [max length 200]",
  "MiddleName": "Optional string [max length 100]",
  "NickName": "Optional string [max length 200]",
  "OtherStateProvince": "Optional string [max length 200]",
  "Phone": "Optional string [max length 64]",
  "Gender": "Optional string [max length 10, see Gender list]",
  "Salutation": "Optional string [max length 10, see Salutation list]",
  "StateProvince": "Optional string[max length 200, See State list]",
  "Street1": "Optional string[max length 200]",
  "Street2": "Optional string[max length 200]",
  "Title": "Optional [max length 256]",
  "Region": "Optional string[max length 100, See Attendee Region pull-down value list]",
  "Question1": "Optional int[max length 4]",
  "Question2": "Optional int[max length 4]",
  "Question3": "Optional int[max length 4]",
  "Question4": "Optional int[max length 4]",
  "Question5": "Optional int[max length 4]",
  "CustomDetail1": "Optional string[max length 200]",
  "CustomDetail2": "Optional string[max length 200]",
  "CustomDetail3": "Optional string[max length 200]",
  "CustomDetail4": "Optional string[max length 200]",
  "CustomDetail5": "Optional string[max length 200]",
  "UniqueID": "Optional string[max length 50]",
  "BillToCountry": "Optional string[max length 200, See Country list]",
  "BadgevillePlayerId": "Optional string[max length 30]",
  "CitizenshipCountry": "Optional string[max length 200, See Country list]",
  "EmployeeID": "Optional string[max length 20]",
  "IsManager": "Bool",
  "ManagerName": "Optional string, [Manager Name  list]",
  "ManagerID": "Optional int[max length 4]",
  "SuperUser": {
    "ID": "Optional integer"
  },
  "Organization": {
    "ID": "Optional integer"
  },
  "BillToOrganization": {
    "ID": "Optional integer"
  }
}

Response Codes:

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

Delete Attendees :

Delete the Attendee by 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 : Attendees ID to be deleted provided in endpoint

URI : DEL https://api.viewcentral.com/api/attendees/{attendee ID}

Response Codes:

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

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

Files(0)

Need Answers Fast?

Help Center

Litmos

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

Fields

Trending Articles

Need Answers Fast?