All pages
Powered by GitBook
1 of 1

Loading...

Get licensee

Gets a single licensee object by ID.

get

Get licensee by ID. Available for Client and Operations accounts. Returns a single licensee with buyer, seller, address, and audit. Optional select query parameter controls which fields are returned.

Path parameters
idstringRequired

Licensee identifier.

Query parameters
selectstringOptional

Optional RQL select statement to limit returned fields.

Responses
200

OK

application/json
idstringOptional
atstring · date-time · nullableOptional
idstringOptional
namestringOptional
iconstring · nullableOptional
revisioninteger · int32Optional
atstring · date-time · nullableOptional
idstringOptional
namestringOptional
iconstring · nullableOptional
revisioninteger · int32Optional
atstring · date-time · nullableOptional
idstringOptional
namestringOptional
iconstring · nullableOptional
revisioninteger · int32Optional
omittedstring[]Optional
namestringOptional
iconstring · nullableOptional
revisioninteger · int32Optional
externalIdstring · nullableOptional
statusstring · enumOptionalPossible values:
addressLine1string · nullableOptional
addressLine2string · nullableOptional
postCodestring · nullableOptional
citystring · nullableOptional
statestring · nullableOptional
countrystring · nullableOptional
useBuyerAddressboolean · nullableOptional
descriptionstring · nullableOptional
idstringOptional
namestringOptional
iconstring · nullableOptional
revisioninteger · int32Optional
typestring · enumOptionalPossible values:
statusstring · enumOptionalPossible values:
idstringOptional
namestringOptional
iconstring · nullableOptional
revisioninteger · int32Optional
idstringOptional
namestringOptional
iconstring · nullableOptional
revisioninteger · int32Optional
externalIdstring · nullableOptional
clientbooleanOptional
partnerbooleanOptional
404

Not Found

application/json
typestring · nullableOptional
titlestring · nullableOptional
statusinteger · int32 · nullableOptional
detailstring · nullableOptional
instancestring · nullableOptional
Other propertiesanyOptional
get/public/v1/accounts/licensees/{id}
GET /public/v1/accounts/licensees/{id} HTTP/1.1
Host: api.platform.softwareone.com
Accept: */*
{
  "id": "LCE-8893-6916-0000",
  "revision": 2,
  "name": "Rolls-Royce Canada Limited",
  "externalId": "WW-CON-12345678",
  "status": "Active",
  "buyer": {
    "id": "BUY-8928-0965",
    "name": "Rolls-Royce Canada Limited"
  },
  "seller": {
    "id": "SEL-4717-3953",
    "name": "SoftwareOne Canada, Inc."
  },
  "address": {
    "addressLine1": "123 Main Street",
    "postCode": "12345",
    "city": "Cityville",
    "state": "S",
    "country": "ST"
  }
}

Get licensee by ID