Skip to main content

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​

GetPersonResponse()

Schema
    firstName stringnullable

    Nome.

    lastName stringnullable

    Sobrenome.

    email stringnullable

    Email.

    phone stringnullable

    Telefone.

    cpf stringnullable

    CPF.

    passport stringnullable

    Passaporte.

    dob stringnullable

    Data de nascimento.

    country stringnullable

    País de origem.

    registrationSource stringnullable

    Origem de cadastro.

    addressStreetName stringnullable

    Rua.

    addressNumber stringnullable

    Número.

    addressZipCode stringnullable

    CEP.

    addressAdditionalInformation stringnullable

    Complemento.

    addressDistrict stringnullable

    Bairro.

    addressCity stringnullable

    Cidade.

    addressState stringnullable

    Estado.

    ageGroup nullable

    Possible values: [ADULT, CHILD, null]

    Adulto ou criança.

    loyaltyLevel stringnullable

    Nível fidelidade.

    loyaltyOptIn booleannullable

    Opt-in fidelidade.

    id stringnullable
    creationDate stringnullable
    enabled booleannullable

    Default value: true

Loading...