# Browse parties

Browse parties and optionally filtered by criteria. Results are paginated.

Endpoint: GET /parties
Version: 2025-01-01
Security: basicAuth

## Query parameters:

  - `page` (integer)
    Positive whole number indicating which page of the selected parties to return. Greater than 0.
    Example: 5

  - `size` (integer)
    Number of items listed per page.
    Example: 10

  - `entity` (array)
    Entity or entities to filter parties by.
    Example: ["Entity123"]

  - `active` (boolean)
    Returns parties that are active when set to true.
    Example: true

  - `type` (string)
    Type of parties to return.
    Enum: "person", "soleTrader", "company"

## Header parameters:

  - `WP-Api-Version` (string, required)
    The API version.
    Example: "2025-01-01"

## Response 200 fields (application/json):

  - `parties` (array, required)
    List of parties on the current page.

  - `pagination` (object, required)
    Pagination information for browsing.

  - `pagination.page` (integer, required)
    Positive whole number indicating which page of the selected parties to return. Greater than 0.
    Example: 5

  - `pagination.size` (integer, required)
    Number of items listed per page.
    Example: 10

  - `pagination.pageCount` (integer)
    Total number of pages.
    Example: 3

  - `pagination.totalNumberOfRecords` (integer)
    Total number of records in the database for the selected parties.
    Example: 1227

## Response 400 fields (application/json):

  - `errorName` (string)
    An ordinal error type that is part of the API contract. It is machine readable, but also human readable for clarity and semantic understanding of the error.
    Example: "bodyDoesNotMatchSchema"

  - `message` (string)
    A human readable message giving a corrective action for the error. THIS IS NOT FOR MACHINE CONSUMPTION.

  - `validationErrors` (array)

  - `validationErrors.errorName` (string)

  - `validationErrors.message` (string)

  - `validationErrors.path` (string)

  - `validationErrors.jsonPath` (string)

  - `validationErrors.queryParameter` (string)

  - `validationErrors.pathParameter` (string)

  - `pathParameter` (string)

  - `queryParameter` (string)

  - `jsonPath` (string)

## Response 500 fields (application/json):

  - `errorName` (string)
    An ordinal error type that is part of the API contract. It is machine readable, but also human readable for clarity and semantic understanding of the error.
    Example: "bodyDoesNotMatchSchema"

  - `message` (string)
    A human readable message giving a corrective action for the error. THIS IS NOT FOR MACHINE CONSUMPTION.

  - `validationErrors` (array)

  - `validationErrors.errorName` (string)

  - `validationErrors.message` (string)

  - `validationErrors.path` (string)

  - `validationErrors.jsonPath` (string)

  - `validationErrors.queryParameter` (string)

  - `validationErrors.pathParameter` (string)

  - `pathParameter` (string)

  - `queryParameter` (string)

  - `jsonPath` (string)

## Response 503 fields (application/json):

  - `errorName` (string)
    An ordinal error type that is part of the API contract. It is machine readable, but also human readable for clarity and semantic understanding of the error.
    Example: "bodyDoesNotMatchSchema"

  - `message` (string)
    A human readable message giving a corrective action for the error. THIS IS NOT FOR MACHINE CONSUMPTION.

  - `validationErrors` (array)

  - `validationErrors.errorName` (string)

  - `validationErrors.message` (string)

  - `validationErrors.path` (string)

  - `validationErrors.jsonPath` (string)

  - `validationErrors.queryParameter` (string)

  - `validationErrors.pathParameter` (string)

  - `pathParameter` (string)

  - `queryParameter` (string)

  - `jsonPath` (string)