Autocomplete Route

Schema

Important

This REST Route is under active development; the schema will change.

id

integer		Unique identifier for the Entry.

Read-only

Context: view, edit, embed
type

string		The Entry type.

Context: view, edit, embed

One of: family, individual, organization
slug

string		A unique alphanumeric identifier for the Entry.

Context: view, edit, embed
link

string (uri)		URL to the post.

Read-only

Context: view, edit, embed
fn

string		The Entry’s full name.

Read-only

Context: view, edit, embed
honorific_prefix

object		An honorific prefix preceding a person’s name such as Dr/Mrs/Mr.

Context: view, edit, embed
given_name

object		Given name. In the U.S., the first name of a person.

Context: view, edit, embed
additional_name

object		An additional name for a person. The middle name of a person.

Context: view, edit, embed
family_name

object		Family name. In the U.S., the last name of a person.

Context: view, edit, embed
honorific_suffix

object		An honorific suffix preceding a person’s name, such as M.D. or Ph.D.

Context: view, edit, embed
job_title

object		The job title of the Entry (for example, Financial Manager).

Context: view, edit, embed
org

object		The organization object for the Entry.

Properties:
– organization_name (string) Organization name.
– organization_unit (string) Department (organization unit).

Context: view, edit, embed
visibility

string		Visibility of the Entry.

Context: view, edit, embed

One of: private, public, unlisted
status

string		Moderation status of the Entry.

Context: view, edit, embed

One of: approved, pending

Endpoints

name

Query this endpoint to retrieve a collection of entries that have a name that starts with the search term argument.

Arguments
search

string		Search for the string that starts with the supplied characters.
Example Request
fetch("https://example.com/wp-json/cn-api/v1/autocomplete/name?search=Joh", {
	method: "get",
})
	.then((data) => data.json())
	.then(console.log);

last_name

Query this endpoint to retrieve a collection of entries that have a last_name that starts with the search term argument.

Arguments
search

string		Search for the string that starts with the supplied characters.
Example Request
fetch("https://example.com/wp-json/cn-api/v1/autocomplete/last_name?search=smit", {
	method: "get",
})
	.then((data) => data.json())
	.then(console.log);

title

Query this endpoint to retrieve a collection of entries that have a title that starts with the search term argument.

Arguments
search

string		Search for the string that starts with the supplied characters.
Example Request
fetch("https://example.com/wp-json/cn-api/v1/autocomplete/title?search=assis", {
	method: "get",
})
	.then((data) => data.json())
	.then(console.log);

organization

Query this endpoint to retrieve a collection of entries that have an organization name that starts with the search term argument.

Arguments
search

string		Search for the string that starts with the supplied characters.
Example Request
fetch("https://example.com/wp-json/cn-api/v1/autocomplete/organization?search=goo", {
	method: "get",
})
	.then((data) => data.json())
	.then(console.log);

department

Query this endpoint to retrieve a collection of entries that have a department name that starts with the search term argument.

Arguments
search

string		Search for the string that starts with the supplied characters.
Example Request
fetch("https://example.com/wp-json/cn-api/v1/autocomplete/department?search=huma", {
	method: "get",
})
	.then((data) => data.json())
	.then(console.log);

district

Query this endpoint to retrieve a collection of entries that have a district name that starts with the search term argument.

Arguments
search

string		Search for the string that starts with the supplied characters.
Example Request
fetch("https://example.com/wp-json/cn-api/v1/autocomplete/district?search=hem", {
	method: "get",
})
	.then((data) => data.json())
	.then(console.log);

county

Query this endpoint to retrieve a collection of entries that have a county name that starts with the search term argument.

Arguments
search

string		Search for the string that starts with the supplied characters.
Example Request
fetch("https://example.com/wp-json/cn-api/v1/autocomplete/county?search=yor", {
	method: "get",
})
	.then((data) => data.json())
	.then(console.log);

city

Query this endpoint to retrieve a collection of entries that have a city name that starts with the search term argument.

Arguments
search

string		Search for the string that starts with the supplied characters.
Example Request
fetch("https://example.com/wp-json/cn-api/v1/autocomplete/city?search=phoe", {
	method: "get",
})
	.then((data) => data.json())
	.then(console.log);

state

Query this endpoint to retrieve a collection of entries that have a state name that starts with the search term argument.

Arguments
search

string		Search for the string that starts with the supplied characters.
Example Request
fetch("https://example.com/wp-json/cn-api/v1/autocomplete/state?search=ut", {
	method: "get",
})
	.then((data) => data.json())
	.then(console.log);

zipcode

Query this endpoint to retrieve a collection of entries that have a zipcode that starts with the search term argument.

Arguments
search

string		Search for the string that starts with the supplied characters.
Example Request
fetch("https://example.com/wp-json/cn-api/v1/autocomplete/zipcode?search=056", {
	method: "get",
})
	.then((data) => data.json())
	.then(console.log);

country

Query this endpoint to retrieve a collection of entries that have a country name that starts with the search term argument.

Arguments
search

string		Search for the string that starts with the supplied characters.
Example Request
fetch("https://example.com/wp-json/cn-api/v1/autocomplete/country?search=ukra", {
	method: "get",
})
	.then((data) => data.json())
	.then(console.log);