Skip to main content

SearchStakeHolderResponseBody

Response body for stakeholder search operations

errorstring | nullnullable

Error message (present only if there was an error)

Example: Your request could not be processed. Please try again later or contact support.
result object[]

Collection of stakeholders matching the search criteria

  • Array [
    • uiduuidrequired

    Unique identifier of the stakeholder

    Example: 123e4567-e89b-12d3-a456-426614174000
    typestringrequired

    Type of stakeholder (person or company)

    Example: person
    firstNamestring | nullnullable

    First name of the stakeholder (null for companies)

    Example: John
    lastNamestring | nullnullable

    Last name of the stakeholder (null for companies)

    Example: Doe
    namestringrequired

    Full name of the stakeholder (null for person, company name required)

    Example: Stonal
    sirenstring | nullnullable

    SIREN number of the companies (null for persons)

    Example: 123456789
    addressstring | nullnullable

    Address of the company

    postalCodestring | nullnullable

    Postal code of the company

    citystring | nullnullable

    City of the company

    externalCodestring | nullnullable

    External code of the company

    contactsDetails object[]

    List of contact details of the stakeholder

  • Array [
    • phoneNumberstring | nullnullable

    Phone number of the contact

    Example: 0123456789
    additionalInfosstring | nullnullable

    Additional infos of the contact

    Example: Some additional infos
    emailstring | nullnullable

    Email address required for person and company

    Example: john.doe@example.com
    creationDatestring | nullnullable

    Date of creation of the contact

    Example: 2020-01-01
  • ]
    • contracts object[]

    Stakeholder contracts list

  • Array [
    • idstringrequired

    Id of the contract

    typestringrequired

    Type of the contract

    Example: LEASE
    codestringrequired

    Code of the contract

    labelstring | nullnullable

    Label of the contract

    assetUidsstring[]nullable

    Asset stonal ids linked of the contract

  • ]
    • isActivebooleanrequired

    Active status of the stakeholder

    faxstring | nullnullable

    Fax of the company

    functionstring | nullnullable

    Function of the person

    creationDatestring | nullnullable

    Date of creation of the stakeholder

    Example: 2024-01-15
    updatedAtstring | nullnullable

    Date of last update of the stakeholder

    Example: 2024-11-10T14:30:00
  • ]
    • totalint64nullable

    Total number of stakeholders matching the search criteria

    Example: 42
    totalPagesint32nullable

    Total number of pages available

    Example: 5
    pageRequested object
    oneOf
    pageint32required

    Page number (zero-based)

    Example: 0
    sizeint32required

    Number of items per page

    Example: 10
    sortstring | nullnullable

    Field used for sorting

    Example: name
    directionstring | nullnullable

    Sort direction (ASC or DESC)

    Example: ASC
    SearchStakeHolderResponseBody
    {
      "error": "Your request could not be processed. Please try again later or contact support.",
      "result": "Unknown Type: array,null",
      "total": 42,
      "totalPages": 5,
      "pageRequested": {
        "page": 0,
        "size": 10,
        "sort": "name",
        "direction": "ASC"
      }
    }