Request

Response

    Get Saved Search
    GET

    v2/hubs/{hubId}/saved-searches/{savedSearchId}

    Returns an individual Saved Search by id.

    Visibility. HUB-scoped searches are readable by any authenticated hub member; PERSONAL-scoped searches are readable only by their owner (hub admins cannot access another user’s personal searches).

    Resource Information

    Method and URI
    GET
    https://api.aps.autodesk.com/content-catalog/v2/hubs/{hubId}/saved-searches/{savedSearchId}
    Authentication Context
    user context required
    Required OAuth Scopes
    data:read
    Data Format
    JSON

    Request

    Headers

    Authorization*
    string
    Must be Bearer <token>, where <token> is a three-legged access token obtained via an Authorization Code flow or a Secure Service Account flow.

    The Secure Service Account (SSA) flow is designed for headless server-to-server operations. While it functions like a two-legged flow (no user interaction), it is classified as three-legged because it preserves user context.

    Region
    string
    Region identifier for API routing. Defaults to US if not provided.
    * Required

    Request

    URI Parameters

    hubId
    string
    Hub ID that owns the saved search (UUID format, uppercase)
    savedSearchId
    string
    Unique identifier for the saved search (UUID format, uppercase)

    Response

    HTTP Status Code Summary

    200
    OK
    Successfully retrieved saved search
    400
    Bad Request
    The server was unable to process the request. The syntax of the request is malformed or the request is missing a required header. Do not repeat the request without fixing the issue. The response body may indicate what is wrong with the request.
    401
    Unauthorized
    The supplied authorization header was not valid or the supplied token scope was not acceptable. Verify authentication and try again.
    403
    Forbidden
    The request was successfully validated, but lacking the required permissions. Verify your credentials and permissions before you send the request again.
    404
    Not Found
    The requested resource was not found.
    500
    Internal Server Error
    An unexpected error occurred on the server, preventing it from completing your request. Please try again later. If the issue persists, contact the support team for assistance.
    503
    Service Unavailable
    The service is temporarily unavailable. Retry the request after a short delay.

    Response

    Body Structure (200)

    Expand all
    id
    string
    Unique identifier of the saved search (UUID format, uppercase)
    hubId
    string
    Unique identifier of the hub that owns this saved search (UUID format, uppercase)
    scope
    enum:string
    Visibility and ownership scope. HUB searches are visible to and usable by every member of the hub, but only hub admins may create, update, or delete them. PERSONAL searches are visible only to their creator, who is the only one who can manage them — not even hub admins can see or act on another user’s personal searches. Possible values: PERSONAL, HUB
    name
    string
    Display name for the saved search
    icon
    string
    Optional name of the icon shown on the saved-search card. May be absent when no icon was set.
    groupId
    string
    ID of the Saved Search Group this search belongs to (UUID format, uppercase)
    searchConfiguration
    object
    Structured search criteria for a saved search. At least one of queryText, collectionIds, productVersions, categories, tagIds, contentTypes, measurementSystems, selectFields, sort, or hasTypeCatalog must be present. Submitting a configuration with none of these fields populated results in a 400 error. This constraint is enforced server-side and is not expressed via OpenAPI minProperties.
    queryText
    string
    Free-text search query string

    Max length: 500

    collectionIds
    array: string
    IDs scoping the search (UUID format, max 50). Each entry is either a collection in this hub, or a channel this hub subscribes to from a publisher — a channel is addressed by the ID it has in this hub, not by the publisher’s own collection ID.
    Constraints:
    • Collections and channels cannot be combined. A list must be all collections or all channels; mixing them returns 400.
    • The reserved value UNASSIGNED_CONTENTS may be included alongside collection IDs to also match content that belongs to no collection. Only hub administrators may use it; for anyone else it returns 400, because unassigned content is out of their search scope.
    productVersions
    array: string
    Product version filters (e.g. 2025, 2026)
    categories
    array: string
    Category filters
    tagIds
    array: string
    Tag ID filters (UUID format, max 50)
    contentTypes
    array: string
    Content-type filters. Each value must be one of the supported content types defined by the ContentType enum (e.g. DWG, RVT).
    measurementSystems
    array: string
    Measurement System filters, using the same enum as content metadata (MeasurementSystemEnum).
    selectFields
    array: string
    Result/display fields to include in the search
    sort
    object
    Single sort instruction applied to search results
    field
    enum:string
    Field to sort by. productVersion sorts by the content’s associated product version (e.g. Revit year such as 2025, 2026) — not by a creation or modification date. Possible values: name, createdAt, updatedAt, category, fileType, productVersion
    direction
    enum:string
    Sort direction Possible values: ASC, DESC
    hasTypeCatalog
    boolean
    Restrict the search to content with (true) or without (false) a type catalog.
    permissions
    object
    Permissions the requesting user has on this saved search
    canRead
    boolean
    Whether the user can read this saved search
    canEdit
    boolean
    Whether the user can edit this saved search
    canDelete
    boolean
    Whether the user can delete this saved search
    createdBy
    string
    Creator identifier (Autodesk ID)
    updatedBy
    string
    Last modifier identifier (Autodesk ID)
    createdAt
    datetime: ISO 8601
    Creation timestamp
    updatedAt
    datetime: ISO 8601
    Last update timestamp

    Example

    Successfully retrieved saved search

    Request

    curl -v 'https://developer.api.autodesk.com/content-catalog/v2/hubs/123E4567-E89B-12D3-A456-426614174000/saved-searches/9C72278C-38F4-42A0-8271-57EEF1DD42B1' \
      -H 'Authorization: '
    

    Response

    {
      "id": "9C72278C-38F4-42A0-8271-57EEF1DD42B1",
      "hubId": "757FF58F-AE23-42D8-B303-BD7B53FA2B98",
      "scope": "PERSONAL",
      "name": "Recent Doors",
      "icon": "icon.door",
      "groupId": "C6617546-5865-415C-A5AD-07C4711A228A",
      "searchConfiguration": {
        "queryText": "modern",
        "collectionIds": [
          "550E8400-E29B-41D4-A716-446655440000"
        ],
        "productVersions": [
          "2025"
        ],
        "categories": [
          "Doors"
        ],
        "tagIds": [
          "550E8400-E29B-41D4-A716-446655440000"
        ],
        "contentTypes": [
          "RVT"
        ],
        "measurementSystems": [
          "IMPERIAL"
        ],
        "selectFields": [
          "properties.fileName"
        ],
        "sort": {
          "field": "updatedAt",
          "direction": "DESC"
        },
        "hasTypeCatalog": false
      },
      "permissions": {
        "canRead": true,
        "canEdit": true,
        "canDelete": true
      },
      "createdBy": "AKB2JV55N3SQ55DT",
      "updatedBy": "AKB2JV55N3SQ55DT",
      "createdAt": "2024-01-15T10:30:00Z",
      "updatedAt": "2024-01-16T14:20:00Z"
    }
    
    Show More