loading

Accounts | Hitchhikers Platform

Overview

The Accounts endpoints are read-only endpoints that allow you to retrieve high-level information about your Yext account. You can get information about a single Yext account that you own using Accounts: Get. If you have Partner Portal, you can retrieve information about all of the accounts you have access to using Accounts: List.

Use Cases
  • Programmatically retrieve your account name and primary contact information
  • Programmatically retrieve a list of your sub-accounts
Reference Docs

Accounts: List

List all accounts that you have access to. Unless you are in Partner Portal mode, this will only be your own account.

query Parameters
v
required
string

A date in YYYYMMDD format.

name
string

Returns only accounts whose name contains the provided string

limit
integer <= 1000
Default: 100
offset
integer
Default: 0

Number of results to skip. Used to page through results. Cannot be used together with pageToken.

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "response": {
    }
}

Accounts: Get

Get details for an account

path Parameters
accountId
required
string
query Parameters
v
required
string

A date in YYYYMMDD format.

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "response": {
    }
}