SearchResponseOfCompany

Response from a search operation with pagination metadata.

  • hasMore
    Type: boolean

    Whether there are more results available beyond this page. True if (offset + limit) < total.

  • limit
    Type: integer | string Pattern: ^-?(?:0|[1-9]\d*)$Format: int32

    The limit used for this page (echoed from request). Useful for constructing next page requests.

  • offset
    Type: integer | string Pattern: ^-?(?:0|[1-9]\d*)$Format: int32

    The offset used for this page (echoed from request). Useful for constructing next page requests.

  • results
    Type: array object[] · Company[]

    The search results for this page.

    A company in your network.

    • createdUtc
      Type: stringFormat: date-time
      required

      Creation timestamp (UTC).

    • etag
      Type: string
      required

      ETag for concurrency control.

    • id
      Type: string
      required

      Company ID.

    • name
      Type: string
      required

      Company name.

    • updatedUtc
      Type: stringFormat: date-time
      required

      Last update timestamp (UTC).

    • changeOrigin
      Type: null | string

      Origin channel that triggered this change. Informational only; treat as an opaque value.

    • changeType
      Type: null | string

      Type of change that produced this version: "create", "update", or "delete"

    • contacts
      Type: array object[] · ContactLink[]

      Contacts linked to this company, primary first.

      Lightweight contact reference embedded on a company, showing the relationship.

    • countryCode
      Type: null | string

      ISO 3166-1 alpha-2 country code.

    • deletedUtc
      Type: null | stringFormat: date-time

      Deletion timestamp (UTC) if soft-deleted.

    • domain
      Type: null | string

      Company domain (e.g., "acme.com"). Set directly via API or auto-extracted from homepageUrl. Normalized to lowercase without www prefix.

    • externalRefs
      Type: array object[] · ExternalRef[]

      External references.

      Represents an external system reference (e.g., Salesforce, HubSpot, Pipedrive). Supports multiple CRM systems simultaneously.

    • homepageUrl
      Type: null | string

      Company homepage URL.

    • linkedInUrl
      Type: null | string

      Company LinkedIn URL.

    • profilePictureUrl
      Type: null | string

      URL to download the company logotype/profile picture, if set.

    • strategy
      Type: null | string

      Investment strategy.

    • tags
      Type: array string[]

      List of tags.

    • uri
      Type: null | string

      Opaque canonical Propstreet entity URI for deep linking.

  • total
    Type: integer | string Pattern: ^-?(?:0|[1-9]\d*)$Format: int32

    Total number of results matching the search criteria (before pagination). Useful for displaying "Showing 1-100 of 247 results" in UIs.

Propstreet API Documentation