Party

Search parties as admin

Changed on

Delegated Aura access tokens require parties:read; missing scope returns 403 FORBIDDEN. Searches Party records for authenticated administrators.

query performs a case-insensitive substring search across Party name, phone, and email. name, phone, and email restrict the substring match to one contact/name field. created and updated accept inclusive RFC3339 ranges using min and max query members.

Results use deterministic cursor pagination. The default sort is name ascending; override it by providing both sort and order. Valid sort fields are name, email, phone, created, and updated; Party ID is always the final deterministic tie-breaker. Page sizes are clamped to 1–100, with a default of 21. The returned ListingSource ID searchAfter cursor is omitted on the terminal page and should be sent with the same filters and sort. Responses always use Cache-Control: no-store because contact data is returned.

get/api/v1/admin/parties

Request

  • Base URL: https://api.stage.aura-historia.com
  • URL: https://api.stage.aura-historia.com/api/v1/admin/parties
  • Auth: one of:
    • HTTP bearer
    • HTTP bearer

Query parameters

querystring

Optional case-insensitive substring query across Party name, phone, and email.

namestring

Optional case-insensitive substring filter for the Party name.

phonestring

Optional case-insensitive substring filter for the Party phone number.

emailstring

Optional case-insensitive substring filter for the Party email address.

created[min]string date-time

Optional inclusive lower bound for the Party creation timestamp (RFC3339).

created[max]string date-time

Optional inclusive upper bound for the Party creation timestamp (RFC3339).

updated[min]string date-time

Optional inclusive lower bound for the Party update timestamp (RFC3339).

updated[max]string date-time

Optional inclusive upper bound for the Party update timestamp (RFC3339).

sort'name' | 'email' | 'phone' | 'created' | 'updated'

Fields available for sorting admin Party-search results. Party ID is always used as a deterministic tie-breaker; absent contact values sort last.

Example:name

Sort field. Valid values are name, email, phone, created, and updated. The default is name ascending.

order'asc' | 'desc'

Sort direction for sort. Provide both sort and order to override the default.

searchAfterstring

Opaque Party ID cursor returned by the previous page. It is omitted when no next page exists.

sizeinteger

Number of Party summaries requested per page. The server clamps values to the inclusive range 1–100.

Response

Party summaries returned successfully.

sizeinteger required

Number of items returned in the current page.

searchAfterstring

Party ID cursor for the next page, omitted when no more results are available.

totalinteger

Total matching Parties when provided by the reader; omitted otherwise.

Example response

{
  "size": 21,
  "searchAfter": "pty_71m2jxjctefykb6crqka16yf6z",
  "total": 42
}

Changes

  • 927a680d096bRevision changes
    • breaking

      the response property's min was decreased from 1.00 to 0.00 for the response status

  • 999eda3fdd63Revision changes
    • breaking

      the // response's property format changed from uuid to no format for status

    • breaking

      the response's property format changed from uuid to no format for status

    • breaking

      removed the required property / from the response with the status

    • breaking

      removed the required property / from the response with the status

    • breaking

      removed the required property / from the response with the status

    • breaking

      removed the required property / from the response with the status

    • breaking

      removed the required property / from the response with the status

    • info

      for the query request parameter searchAfter, the format was generalized from uuid to no format

    • info

      added the required property / to the response with the status

    • info

      added the required property / to the response with the status

    • info

      added the required property / to the response with the status

    • info

      added the required property / to the response with the status

    • info

      added the required property / to the response with the status