SOsoraban
Entities

List entities

Changed on
get/entities

Request

Query parameters

show_inactiveboolean

Include entities marked inactive.

namestring

Exact match on entity name.

external_entity_idstring

Exact match on your own identifier for the entity.

user_idinteger

Only entities owned by this client.

pageinteger

1-based page number.

per_pageinteger

Results per page.

Response

A page of entities.

idinteger
entity_typestring nullable
namestring nullable
streetstring nullable
statestring nullable
citystring nullable
zipstring nullable
countrystring nullable
inactiveboolean nullable
created_atstring date-time
upload_linkstring nullable
business_emailstring nullable
other_emailstring nullable
external_entity_idstring nullable
deleted_atstring date-time nullable
hash_idstring nullable
firm_role_summarystring

A formatted, human-readable summary of who holds which role on the entity, not structured data. Empty when no roles are assigned. Use GET /entities/{entity_id}/firm_role_assignments if you need the underlying ids.

firm_group_idinteger nullable
firm_groupobject nullable

Example response

[
  {
    "firm_role_summary": "Partner: Jane Doe, Manager: John Smith"
  }
]

Changes

  • 1c230fa547adRevision changes
    • breaking

      the response property / became nullable for the status

    • breaking

      the response property / became nullable for the status

    • breaking

      the response property / became nullable for the status

    • breaking

      the response property /// became nullable for the status

    • breaking

      the response property /// became nullable for the status

    • breaking

      the response property /// became nullable for the status

    • breaking

      the response property /// became nullable for the status

    • breaking

      the response property /// became nullable for the status

    • breaking

      the response property / became nullable for the status

    • breaking

      the response property // became nullable for the status

    • breaking

      the response property // became nullable for the status

    • breaking

      the response property // became nullable for the status

    • breaking

      the response property // became nullable for the status

    • breaking

      the response property // became nullable for the status

    • breaking

      the response property became optional for the status

    • breaking

      the response property / became optional for the status

    • breaking

      the response property / became optional for the status

    • breaking

      the response property / became optional for the status

    • breaking

      the response property / became optional for the status

    • breaking

      the response property / became optional for the status

    • breaking

      the response property / became optional for the status

    • breaking

      the response property /// became optional for the status

    • breaking

      the response property /// became optional for the status

    • breaking

      the response property /// became optional for the status

    • breaking

      the response property /// became optional for the status

    • breaking

      the response property /// became optional for the status

    • breaking

      the response property /// became optional for the status

    • breaking

      the response property /// became optional for the status

    • breaking

      the response property / became optional for the status

    • breaking

      the response property / became optional for the status

    • breaking

      the response property // became optional for the status

    • breaking

      the response property // became optional for the status

    • breaking

      the response property // became optional for the status

    • breaking

      the response property // became optional for the status

    • breaking

      the response property // became optional for the status

    • breaking

      the response property // became optional for the status

    • breaking

      the response property // became optional for the status

    • breaking

      the /// response's property type changed from string to string null, and format from email to no format for status

    • breaking

      the /// response's property type changed from string to string null, and format from email to no format for status

    • breaking

      the / response's property type changed from string to string null, and format from uri to no format for status

    • breaking

      the // response's property type changed from string to string null, and format from email to no format for status

    • breaking

      the // response's property type changed from string to string null, and format from email to no format for status

    • breaking

      removed the required property / from the response with the status

    • info

      api operation id listEntities was added

    • info

      the endpoint scheme security bearerAuth was removed from the API

    • info

      api tag Entities added

    • info

      removed the non-success response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property /// to the response with the status

    • info

      added the optional property /// to the response with the status

    • info

      added the optional property /// to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status