Check whether a username is available

GET

/auth/usernames/{name}

Code sample: Shell / cURL

curl --request GET \
  --url https://api.grepvine.ai/v1/auth/usernames/example

Parameters

Path Parameters

name

required

An account or organization name. Accounts and organizations share one namespace. A name keeps the case it was created with, and any spelling that differs only in case refers to it; no other account or organization can take such a spelling.

string

/^[A-Za-z][A-Za-z0-9-]{2,62}$/

Responses

200

Whether an account can register this username now. Accounts and organizations share one namespace. The answer can change before the name is registered.

Media typeapplication/json

object

name

required

An account or organization name. Accounts and organizations share one namespace. A name keeps the case it was created with, and any spelling that differs only in case refers to it; no other account or organization can take such a spelling.

string

/^[A-Za-z][A-Za-z0-9-]{2,62}$/

available

required

boolean

Example ^generated

{
  "name": "example",
  "available": true
}

default

The request failed. A 429 carries Retry-After; the index is busy absorbing recent writes or is out of request capacity, and clients must slow down and retry after the interval. A 403 with code organization_suspended refuses every operation on a suspended organization’s members, indexes, documents and searches; reading the organization itself still answers and reports suspended, and the client should contact support.

Media typeapplication/json

object

code

required

string

reason

required

string

error

required

string

Example ^generated

{
  "code": "example",
  "reason": "example",
  "error": "example"
}

Headers

X-Request-Id

string

The request identifier used for support and audit correlation.

Retry-After

integer

Seconds to wait before retrying. Sent with every 429 so a client slows down instead of failing.