Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Yext Licenses API

The Licenses API from Yext — 3 operation(s) for licenses.

Yext Licenses API is one of 23 APIs that Yext publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Licenses. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 5 operations across 3 paths, and defines 10 schemas. It is described by OpenAPI 3.0.0, at version 2.0.

Requests are made against a single base URL, https://api.yextapis.com/v2.

5 operations 3 paths 10 schemas 1 DELETE2 GET1 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.0
API Version
2.0
Base URL
https://api.yextapis.com/v2
Authentication
API Key, API Key
Resource Areas
1

Authentication & Security 2

Yext Licenses API declares 2 security schemes for authenticating requests. An API key is passed in the query as api_key (api_key). An API key is passed in the header as api-key (api-key). By default, every request must be authenticated.

Paths & Operations 5

Across 3 paths, the API surfaces 5 operations — 1 DELETE, 2 GET, 1 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Licenses 5
POST
/accounts/{accountId}/license-packs/{licensePackId}/assigned-entities/{entityId}
License Assignment: Create
createLicenseAssignment 5 params → 200default
DELETE
/accounts/{accountId}/license-packs/{licensePackId}/assigned-entities/{entityId}
License Assignment: Delete
deleteLicenseAssignment 5 params → 200default
PUT
/accounts/{accountId}/license-packs/{licensePackId}/assigned-entities/{entityId}
License Assignment: Update
updateLicenseAssignment 5 params body → 200default
GET
/accounts/{accountId}/license-packs
License Packs: List
listLicensePacks 5 params → 200default
GET
/accounts/{accountId}/license-packs/{licensePackId}/assigned-entities
License Assignments: List
listLicenseAssignments 7 params → 200default

Schemas 10

The contract defines 10 schemas that model the data the API accepts and returns. The most detailed are LicensePack (6 properties), ResponseError (4 properties), AssignedEntity (2 properties), LicenseAssignment (2 properties). Each schema is shown below with its type and property counts.

LicenseAssignments
object
2 properties
ResponseMetaWithError
LicensePacks
object
2 properties
NextPageToken
string
This field is only included if there is an additional page of data to display. To retrieve the next page of data, pass this field's value as the pageToken para…
UpdateLicenseAssignmentRequestBody
object
1 property
LicenseAssignment
object
2 properties
LicensePack
object
License pack details.
6 properties
AssignedEntity
object
2 properties
ResponseMeta
object
1 property
ResponseError
object
4 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

yext-licenses-api-openapi.yml Raw ↑

Other APIs Yext publishes across the network.

Yext Account Settings API
Yext Accounts API
Yext Administrative API API
Yext Analytics API
Yext Computations API
Yext Configuration API
Yext Connectors API
Yext Content API API
Yext Domains API
Yext Health Check API
Yext Knowledge Manager API
Yext Listings API