Sign in
ListingSources

Search ListingSources as admin

Changed on

Delegated Aura access tokens require listing-sources:read; missing scope returns 403 FORBIDDEN. Searches ListingSource records for authenticated administrators.

query performs a case-insensitive substring search across the ListingSource name and stable slug, and also the operator Party name and slug. name restricts the substring match to the ListingSource name. listingSourceId and listingSourceSlugId are exact identity filters. operatorPartyId and ingestionMethod are exact filters.

Results use deterministic cursor pagination. The default sort is name ascending; override it by providing both sort and order. Valid sort fields are name, slug, created, and updated; ListingSource 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.

The result contains only safe business-resource fields: ListingSource identity and name, operator Party reference, active ingestion methods, presentation URLs, and referral summary. Provider credentials, webhook secrets, and crawler-local configuration are never returned.

get/api/v1/admin/listing-sources

Request

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

Query parameters

querystring

Optional case-insensitive substring query across source and operator Party text.

namestring

Optional case-insensitive substring filter for the ListingSource name.

listingSourceIdstring

Optional exact ListingSource ID filter.

listingSourceSlugIdstring

Optional exact immutable ListingSource slug filter.

operatorPartyIdstring

Optional exact operator Party ID filter.

ingestionMethod'WEB_CRAWL' | 'SHOPIFY' | 'WOOCOMMERCE' | 'PARTNER_API'

Optional exact active ingestion-method filter.

sort'name' | 'slug' | 'created' | 'updated'

Fields available for sorting admin ListingSource-search results. ListingSource ID is always used as a deterministic tie-breaker.

Example:name

Sort field. Valid values are name, slug, 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 ListingSource ID cursor returned by the previous page. It is omitted when no next page exists.

sizeinteger

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

Response

ListingSource summaries returned successfully.

sizeinteger required

Number of items returned in the current page.

searchAfterstring

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

totalinteger

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

Example response

{
  "size": 21,
  "searchAfter": "ls_11j55nbvjfe7ds34s7gya899a9",
  "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

      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 listingSourceId, the format was generalized from uuid to no format

    • info

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

    • 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