Skip to main content

Person Retrieval

GET 
/v1/api/people/:id

Returns a person by ID, with personal data, address and loyalty wallets (loyaltyData).

Disabled people come back too, with enabled: false.

Request​

Path Parameters

    id stringrequired

Responses​

Successful retrieval.

Schema
    firstName stringnullable

    First name.

    lastName stringnullable

    Last name.

    email stringnullable

    Email.

    phone stringnullable

    Phone.

    cpf stringnullable

    CPF.

    passport stringnullable

    Passport.

    dob stringnullable

    Date of birth.

    country stringnullable

    Country of origin.

    registrationSource stringnullable

    Registration source.

    addressStreetName stringnullable

    Street.

    addressNumber stringnullable

    Address number.

    addressZipCode stringnullable

    Zip code.

    addressAdditionalInformation stringnullable

    Address complement.

    addressDistrict stringnullable

    Neighborhood.

    addressCity stringnullable

    City.

    addressState stringnullable

    State.

    ageGroup nullable

    Possible values: [ADULT, CHILD, null]

    Classification of the age group (Adult or Child).

    loyaltyTier stringnullabledeprecated

    Legacy field, no longer updated. Read the person's levels from loyaltyData[].tier.

    loyaltyOptIn booleannullabledeprecated

    Legacy flag. It does not tell whether the person opted into a loyalty program.

    id stringnullable

    Person ID.

    creationDate stringnullable

    Creation date.

    enabled booleannullable

    Default value: true

    Whether the person is enabled or not.

    loyaltyData object[]

    The person's loyalty wallets, with balance and level.

  • Array [
    • id stringnullable

    ID of the loyalty credential that holds the wallet.

    alias stringnullable

    Credential alias, or its ID when it has no alias.

    balance floatnullable

    Balance.

    nextExpirationAt stringnullable

    Date of the next balance expiration.

    nextExpirationValue floatnullable

    Amount that expires on nextExpirationAt.

    tier stringnullable

    The person's level in this wallet. For a manual loyalty credential, it is the level set with loyaltyTier.

  • ]
Loading...