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 Account Settings API

The Account Settings API from Yext — 10 operation(s) for account settings.

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

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

This API exposes 16 operations across 10 paths, and defines 15 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.

16 operations 10 paths 15 schemas 2 DELETE9 GET2 POST3 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 Account Settings 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 16

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

Account Settings 16
GET
/accounts/{accountId}/roles
Roles: Get
getRoles 2 params → 200default
GET
/accounts/{accountId}/users
Users: List
getUsers 3 params → 200default
POST
/accounts/{accountId}/users
Users: Create
createUser 2 params body → 201default
GET
/accounts/{accountId}/users/{userId}
Users: Get
getUser 3 params → 200default
PUT
/accounts/{accountId}/users/{userId}
Users: Update
updateUser 3 params body → 200default
DELETE
/accounts/{accountId}/users/{userId}
Users: Delete
deleteUser 3 params → 200default
PUT
/accounts/{accountId}/users/{userId}/password
Users: Update Password
updateUserPassword 3 params body → 200default
GET
/accounts
Accounts: List
listAccounts 4 params → 200default
GET
/accounts/{accountId}
Accounts: Get
getAccount 2 params → 200default
GET
/accounts/{accountId}/approvalgroups
Approval Groups: List
getApprovalGroups 2 params → 200default
POST
/accounts/{accountId}/approvalgroups
Approval Groups: Create
createApprovalGroup 2 params body → 200default
GET
/accounts/{accountId}/approvalgroups/{approvalGroupId}
Approval Groups: Get
getApprovalGroup 3 params → 200default
PUT
/accounts/{accountId}/approvalgroups/{approvalGroupId}
Approval Groups: Update
updateApprovalGroup 3 params body → 200default
DELETE
/accounts/{accountId}/approvalgroups/{approvalGroupId}
Approval Groups: Delete
deleteApprovalGroup 3 params → 200default
GET
/accounts/{accountId}/linkedaccounts
LinkedAccounts: List
listLinkedAccounts 8 params → 200default
GET
/accounts/{accountId}/linkedaccounts/{linkedAccountId}
LinkedAccounts: Get
getLinkedAccount 3 params → 200default

Schemas 15

The contract defines 15 schemas that model the data the API accepts and returns. The most detailed are CreateUser (13 properties), User (13 properties), UpdateUser (11 properties), Account (9 properties). Each schema is shown below with its type and property counts.

Account
object
9 properties
CreateUser
object
13 properties
LinkedAccount
object
8 properties
ResponseMetaWithError
User
object
13 properties
Role
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…
CreateUserRequest
4 required
ApprovalGroup
object
4 properties
CreateApprovalGroupRequest
object
3 properties 1 required
UpdateUser
object
11 properties
UpdateUserRequest
1 required
ResponseMeta
object
1 property
UpdatePasswordRequest
object
1 property 1 required
ResponseError
object
4 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

yext-account-settings-api-openapi.yml Raw ↑

Other APIs Yext publishes across the network.

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 Licenses API
Yext Listings API