API Documentation
Company GET

get

Company GET

Obtain the metadata about a company.
Note: if the current user is an administrator of the company, the following additional fields will be returned: Owner, AccountType, SubscriptionPlan, TrialEndDateUtc. The Owner field will populate the EmailAddress, FirstName, LastName, and AccountType of the Owner.
Required Scope: Company, Read

 

URL Parameters

  • Param Name
    Type
    Description
  • COMPANY_GUID
    string
    Public Syncplicity Guid associated with the company

Resource URL

https://api.syncplicity.com/ provisioning/company.svc/{COMPANY_GUID}

Header Parameters


Name Values Description
AppKey
(required)

Consumer Key of the app from Developer Portal

Accept
(required)

Accept type of the request

Request Body

HTTP Basic

OAuth 2.0

API Key

Reset

Make a request and see the response.

Make a request and see the response.

Make a request and see the response.

Response Payload Example


		

Response Payload Schema

Response Error Details

  • HTTP Code
    Error Code
    Description
  • 300
    300

    (Multiple Choices) - Ambiguous data found in request

  • 400
    400

    (Bad request) - Invalid Company ID

  • 401
    401

    (Unauthorized) - Not Authorized: The token is invalid, the header is missing, or the user is inactive

  • 404
    404

    (Not Found) - Company Not Found: The specified company does not exist

Working...