Get account

Get account by ID

get

Get account by ID. Available for Operations account with platform account management permissions. Returns a single account with id, name, type, status, address, eligibility, and audit. Optional select query parameter controls which fields are returned.

Path parameters

idstringRequired

Account identifier.

Query parameters

selectstringOptional

Optional RQL select statement to limit returned fields.

Responses

200

OK

application/json

idstringOptional

namestringOptional

iconstring · nullableOptional

revisioninteger · int32Optional

typestring · enumOptionalPossible values:

statusstring · enumOptionalPossible values:

externalIdstring · nullableOptional

externalNamestring · nullableOptional

technicalSupportEmailstring · nullableOptional

websitestring · nullableOptional

descriptionstring · nullableOptional

defaultLanguageCodestring · nullableOptional

404

Not Found

application/json

get/public/v1/accounts/accounts/{id}

HTTPcURLJavaScriptPython

GET /public/v1/accounts/accounts/{id} HTTP/1.1
Host: api.platform.softwareone.com
Accept: */*

{
  "id": "ACC-1234-1234",
  "revision": 2,
  "name": "Contoso Ltd",
  "type": "Vendor",
  "status": "Active",
  "externalId": "WW-CON-123456",
  "address": {
    "addressLine1": "123 Main Street",
    "postCode": "12345",
    "city": "Cityville",
    "state": "S",
    "country": "ST"
  },
  "eligibility": {
    "client": true,
    "partner": false
  }
}