API commands

Remote Access provides a set of REST APIs that you can use to automate tasks.

REST APIs

Click here to do the following:

  • Get a list of sites

Click here to do the following:

  • Get a list of site applications

Click here to do the following:

  • Get a list of users

  • Get details about a specific user

  • Update a user's status

  • Delete a user

  • Delegate / Revoke admin rights to a user

Click here to do the following:

  • Get a list of vendors

  • Get details about a vendor, identified by their ID

  • Get details about a vendor, identified by their phone number

  • Update a vendor's properties

  • Update a vendor's status

  • Delete a vendor

Click here to do the following:

  • Create a user invitation

  • Create a vendor invitation

  • Get a list of pending invitations

  • Get a specific vendor invitation

  • Delete a vendor invitation

Click here to do the following:

  • Get a list of self-service invitation requests

  • Edit and approve a self-service invitation request

  • Reject a a self-service invitation request

Click here to do the following:

  • Get a list of VendorLDAP groups

  • Create an VendorLDAP group

  • Get details about a specific VendorLDAP group

  • Update an VendorLDAP group's properties

  • Delete a group

Click here to do the following:

  • Get a list of activities

Click here to do the following:

  • Get a list of connectors and their status, per site.

Return codes

For a complete list of return codes, see Return codes.