Request

Response

    List Saved Search Groups
    GET

    v2/hubs/{hubId}/saved-search-groups

    Returns a paginated list of Saved Search Groups visible to the authenticated user in a hub. Hub-scoped groups are visible to all hub members; personal groups are visible only to their owner.

    Resource Information

    Method and URI
    GET
    https://api.aps.autodesk.com/content-catalog/v2/hubs/{hubId}/saved-search-groups
    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 to list saved search groups for (UUID format, uppercase)

    Request

    Query String Parameters

    scope
    enum:string
    Optional scope filter. PERSONAL returns only the caller’s personal groups; HUB returns only hub-wide groups. If omitted, both are returned. Possible values: PERSONAL, HUB
    sort
    string
    Sort order for saved search groups. Accepts a single {field} [asc|desc] clause; this endpoint does not support multiple comma-separated sort clauses.

    Only name is a sortable property. The field may be followed by asc or desc; without a direction specifier, results are sorted ascending. Extra spaces around the field name and direction are ignored.

    Examples: name asc, name desc, name Default: name (ascending).

    limit
    int
    Maximum number of saved search groups to return (default: 20, max: 100)
    cursorState
    string
    Opaque pagination cursor from a previous response

    Response

    HTTP Status Code Summary

    200
    OK
    Successfully retrieved saved search groups. Returns an empty results array when none match.
    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. Review the request and try again.
    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
    results
    array: object
    id
    string
    Unique identifier of the saved search group (UUID format, uppercase)
    hubId
    string
    Unique identifier of the hub that owns this saved search group (UUID format, uppercase)
    scope
    enum:string
    Visibility and ownership scope. HUB groups are visible to and usable by every member of the hub, but only hub admins may create, update, or delete them. PERSONAL groups 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 groups. Possible values: PERSONAL, HUB
    name
    string
    Saved Search Group name
    permissions
    object
    Permissions the requesting user has on this saved search group
    canRead
    boolean
    Whether the user can read this saved search group
    canEdit
    boolean
    Whether the user can edit this saved search group
    canDelete
    boolean
    Whether the user can delete this saved search group
    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
    pagination
    object
    Pagination information for cursor-based navigation
    limit
    int
    The limit value used by the server in the response
    cursorState
    string
    CursorState from the request
    nextUrl
    string
    Link that will return the next page of data. Null if this is the last page
    nextCursorState
    string
    The cursorState parameter for requesting the next page. Intended for clients that build request URLs programmatically instead of using nextUrl. Null if this is the last page

    Example

    Successfully retrieved saved search groups. Returns an empty results array when none match.

    Request

    curl -v 'https://developer.api.autodesk.com/content-catalog/v2/hubs/757FF58F-AE23-42D8-B303-BD7B53FA2B98/saved-search-groups?scope=HUB&sort=name asc&limit=20' \
      -H 'Authorization: '
    

    Response

    {
      "results": [
        {
          "id": "A1B2C3D4-E5F6-7890-ABCD-EF1234567890",
          "hubId": "757FF58F-AE23-42D8-B303-BD7B53FA2B98",
          "scope": "PERSONAL",
          "name": "My Saved Searches",
          "permissions": {
            "canRead": true,
            "canEdit": true,
            "canDelete": true
          },
          "createdBy": "AKB2JV55N3SQ55DT",
          "updatedBy": "AKB2JV55N3SQ55DT",
          "createdAt": "2024-01-15T10:30:00Z",
          "updatedAt": "2024-01-16T14:20:00Z"
        }
      ],
      "pagination": {
        "limit": 20,
        "cursorState": "eyJxYyI6Im...",
        "nextUrl": "https://api.aps.autodesk.com/content-catalog/v2/...",
        "nextCursorState": "eyJxYyI6Im..."
      }
    }
    
    Show More