Person Retrieval

GET 
/v1/api/people/:id

This API endpoint allows the retrieval of existing people. It enables clients to access person details based on specific criteria provided in the request parameters.

Clients can send a GET request to this endpoint with appropriate parameters, such as people ID, name, address, to retrieve the desired person information.

The endpoint ensures flexibility by allowing various filtering options, enabling clients to narrow down the search results based on their specific requirements.

Upon successful retrieval, the client application will receive a response containing detailed information about the requested person, including personal details, loyalty information, address data and any additional preferences or special requests.

In case of errors or if the requested person is not found, the response structure is designed to provide appropriate error messages, facilitating efficient error handling and resolution.

Request

Path Parameters

id stringrequired

Responses

200

GetPersonResponse()

application/json

Schema

Schema

firstName stringnullable

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

Addresss 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).

loyaltyLevel stringnullable

Loyalty level.

loyaltyOptIn booleannullable

Loyalty opt-in.

id stringnullable
creationDate stringnullable
enabled booleannullable

Default value: true

loyaltyData object[]
Lista de programas de fidelidade.
Array [
id stringnullable
Id do programa de fidelidade.
alias stringnullable
Alias do programa de fidelidade.
balance floatnullable
Saldo.
nextExpirationAt stringnullable
Próxima expiração.
nextExpirationValue floatnullable
Próximo valor de expiração.
tier stringnullable
Nível de fidelidade.
]

Example (from schema)

{
  "firstName": "string",
  "lastName": "string",
  "email": "string",
  "phone": "string",
  "cpf": "string",
  "passport": "string",
  "dob": "string",
  "country": "string",
  "registrationSource": "string",
  "addressStreetName": "string",
  "addressNumber": "string",
  "addressZipCode": "string",
  "addressAdditionalInformation": "string",
  "addressDistrict": "string",
  "addressCity": "string",
  "addressState": "string",
  "loyaltyLevel": "string",
  "loyaltyOptIn": true,
  "id": "string",
  "creationDate": "string",
  "enabled": true,
  "loyaltyData": [
    {
      "id": "string",
      "alias": "string",
      "balance": 0,
      "nextExpirationAt": "string",
      "nextExpirationValue": 0,
      "tier": "string"
    }
  ]
}

Loading...