Skip to main content
POST
/
generic
/
data
/
generate
/
contact
Generate synthetic contact data
curl --request POST \
  --url https://apix.spotzee.com/api/ext/generic/data/generate/contact \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/x-www-form-urlencoded' \
  --data count=10 \
  --data locale=en \
  --data seed=12345 \
  --data includePhone=true \
  --data includeSocial=false \
  --data includeAccount=false \
  --data useExampleEmail=false \
  --data allowSpecialCharacters=false \
  --data phoneStyle=international \
  --data emailDomain=example.com
{
  "status": "success",
  "data": {
    "contacts": [
      {
        "email": "jane.smith@company.com",
        "website": "https://example.com",
        "phone": "+1-555-987-6543",
        "username": "jane.smith",
        "displayName": "Jane_Smith"
      }
    ],
    "generated": 1,
    "locale": "en",
    "seed": 12345
  },
  "performance": {
    "generationTime": 2,
    "itemsGenerated": 1,
    "locale": "en"
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.spotzee.com/llms.txt

Use this file to discover all available pages before exploring further.

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