Skip to main content
POST
Generate synthetic contact data

Authorizations

Authorization
string
header
required

Bearer token authentication. Use format: Bearer YOUR_API_KEY

Body

application/x-www-form-urlencoded
count
string

Number of contacts to generate (1-100). Passed as string but must be numeric.

Pattern: ^[1-9]\d?$|^100$
Example:

"10"

locale
string

Locale for generated data (e.g., en, es, fr, de, pt_BR, zh_CN)

Example:

"en"

seed
string

Seed for deterministic generation. Same seed produces same results.

Example:

"12345"

includePhone
enum<string>

Include a generated phone number on each contact.

Available options:
true,
false
Example:

"true"

includeSocial
enum<string>

Include generated social profile URLs on each contact.

Available options:
true,
false
Example:

"false"

includeAccount
enum<string>

Include generated username and display-name fields on each contact.

Available options:
true,
false
Example:

"false"

useExampleEmail
enum<string>

Use reserved example email domains for generated email addresses.

Available options:
true,
false
Example:

"false"

allowSpecialCharacters
enum<string>

Allow special characters in generated email local parts.

Available options:
true,
false
Example:

"false"

phoneStyle
enum<string>

Phone number style when includePhone is true.

Available options:
human,
national,
international
Example:

"international"

emailDomain
string

Domain to use for generated email addresses. Do not combine with useExampleEmail=true.

Example:

"example.com"

Response

Successfully generated contact data

status
enum<string>
required
Available options:
success
data
object
required
performance
object