Apicat Docs
  1. Dynamic values Modules
Apicat Docs
  • What is Apicat?
  • Send requests
    • Create requests
      • Request basics
      • Parameters and body
      • Request headers
      • Request settings
      • Dynamic values
      • HTTP/2
      • SOAP/WebService
    • Authentication and authorization
      • Overview
      • CA and client certificates
      • Authorization types supported by Apidog
      • Digest Auth
      • OAuth 1.0
      • OAuth 2.0
      • Hawk Authentication
      • Kerberos
      • NTLM
      • Akamai EdgeGrid
    • Response and cookies
      • Overview
      • API response in Apidog
      • Create and send cookies
      • Debug requests
    • Dynamic values Modules
      • Airline
      • Animal
      • Color
      • Commerce
      • Company
      • Database
      • Datatype
      • Date
      • Finance
      • Food
      • Git
      • Hacker
      • Helpers
      • Image
      • Internet
      • Location
      • Lorem
      • Music
      • Number
      • Person
      • Phone
      • Science
      • String
      • System
      • Vehicle
      • Word
  • Environments & variables
    • Overview
    • Using variables
    • Environments & services
  • Pre/Post processors
    • Overview
    • Assertion
    • Extract variable
    • Wait
    • Database operations
      • Overview
      • MySQL
      • MongoDB
      • Redis
      • Oracle Client
    • Using scripts
      • Overview
      • Pre processor scripts
      • Post processor scripts
      • Public scripts
      • Postman scripts reference
      • Calling other programming languages
      • Using JS libraries
      • Visualizing responses
      • Script examples
        • Assertion scripts
        • Using variables in scripts
        • Using scripts to modify request messages
        • Other examples
  • Best practices
    • How to handle API signatures
    • How to access OAuth 2.0 protected APIs
    • Apidog collaboration workflow
    • Managing authentication state in Apidog
  • Account & preferences
    • Account settings
    • Generate OpenAPI access token
    • Language settings
    • Hot keys
    • Network proxy configuration
    • Data backup
    • Updating Apidog
    • Deleting account
    • Experimental Features
  • References
    • API-Design First Approach
    • Apidog OpenAPI/Swagger Specificaiton Extensions
    • JSONPath
    • XPath
    • Regular Expressions
    • JSON Schema
    • CSV File Format
    • Install Java Environment
    • Runner deployment environment
    • Apidog flavored Markdown
  1. Dynamic values Modules

Person

Module to generate people's personal information such as names and job titles.
Overview
To generate a full name, use {{$person.fullName}}. Note that this is not the same as simply concatenating {{$person.firstName}} and {{$person.lastName}}, as the full name may contain a prefix, suffix, or both. Additionally, different supported locales will have differing name patterns. For example, the last name may appear before the first name, or there may be a double or hyphenated first or last name.
You can also generate the parts of a name separately, using {{$person.prefix}}, {{$person.firstName}}, {{$person.middleName}}, {{$person.lastName}}, and {{$person.suffix}}. Not all locales support all of these parts.
Many of the methods in this module can optionally choose either female, male or mixed names.
Job-related data is also available. To generate a job title, use {{$person.jobTitle}}.
This module can also generate other personal information which might appear in user profiles, such as {{$person.gender}}, {{$person.zodiacSign}}, and {{$person.bio}}.
Related modules
For personal contact information like phone numbers and email addresses, see the Phone and Internet modules.

bio#

Returns a random short biography
Returns: string
Examples

firstName#

Returns a random first name.
Parameters
NameTypeDefaultDescription
sex'female' | 'male'The optional sex to use. Can be either 'female' or 'male'.
Returns: string
Examples

fullName#

Generates a random full name.
Parameters
NameTypeDefaultDescription
firstNamestring{{$person.firstName}}The optional first name to use. If not specified a random one will be chosen.
lastNamestring{{$person.lastName}}The optional last name to use. If not specified a random one will be chosen.
sex'female' | 'male'{{$helpers.arrayElement(['female','male'])}}The optional sex to use. Can be either 'female' or 'male'.
Returns: string
Examples

gender#

Returns a random gender.
Returns: string
Examples

jobArea#

Generates a random job area.
Returns: string
Examples

jobDescriptor#

Generates a random job descriptor.
Returns: string
Examples

jobTitle#

Generates a random job title.
Returns: string
Examples

lastName#

Returns a random last name.
Parameters
NameTypeDefaultDescription
sex'female' | 'male'The optional sex to use. Can be either 'female' or 'male'.
Returns: string
Examples

middleName#

Returns a random middle name.
Parameters
NameTypeDefaultDescription
sex'female' | 'male'The optional sex to use. Can be either 'female' or 'male'.
Returns: string
Examples

prefix#

Returns a random person prefix.
Parameters
NameTypeDefaultDescription
sex'female' | 'male'The optional sex to use. Can be either 'female' or 'male'.
Returns: string
Examples

sex#

Returns a random sex.
Output of this method is localised, so it should not be used to fill the parameter sex available in some other modules for example {{$person.firstName}}.
Returns: string
Examples

sexType#

Returns a random sex type. The SexType is intended to be used in parameters and conditions.
Returns: 'female' | 'male'
Examples

suffix#

Returns a random person suffix.
Returns: string
Examples

zodiacSign#

Returns a random zodiac sign.
Returns: string
Examples

Modified at 2025-06-25 07:57:16
Previous
Number
Next
Phone
Built with