Skip to content

Get Licenses

Endpoint

http
GET /unified/user-directory/licenses/{id}
Integrations supported
  • Salesforce

Path parameters

id
string
REQUIRED · The ID of the resource.
Example: 23423523

Query parameters

integrated_account_id
string · uuid
REQUIRED · The ID of the integrated account to use for the request.
Example: 62f44730-dd91-461e-bd6a-aedd9e0ad79d

Response Body

id
string
REQUIRED · Unique identifier for the license.
Supported in
  • Salesforce
name
string
Name of the license.
Supported in
  • Salesforce
description
string
Description for the license.
available_quantity
number
Total number of licenses that can be assigned to users.
Supported in
  • Salesforce
assigned_quantity
number
Number of licenses that have been assigned to users.
Supported in
  • Salesforce
unit_amount
string
Unit amount for the license.
is_paid
boolean
Whether the license is paid or not.
Supported in
  • Salesforce
currency
string
Currency for the license.
status
string
Status for the license
All possible enum values:
  • active
  • inactive
Supported in
  • Salesforce
created_at
string
Date and time when the license was created.
Supported in
  • Salesforce
updated_at
string
Date and time when the license was last updated.
Supported in
  • Salesforce
remote_data
object
Raw data returned from the remote API call.