XExenforo-ltd
Resources

Get a list of resources

Changed on

Get a list of resources.

get/resources/

Request

  • Base URL
    https://example.com/api
  • Auth
    • OAuth 2
      Authorization codehttps://example.com/oauth2/authorize
      Token URLhttps://example.com/api/oauth2/token
      Scopesresource:read
    • or API key in header XF-Api-Key
  • TypeScript
    A function with typed inputs. Its response is checked against the schema.

Query parameters

pageinteger
prefix_idinteger

Filters to only resources with the specified prefix.

typestring

Filters to only resources of the specified type: free, paid.

creator_idinteger

Filters to only resources created by the specified user ID.

orderstring

Method of ordering: last_update, resource_date, rating_weighted, download_count, title

directionstring

Either "asc" or "desc" for ascending or descending. Applies only if an order is provided.

Response

OK

Changes

  • e271d0e41f6dRevision changes
    • breaking

      the response's property type changed from string to object for status

    • info

      api operation id get_resources_ removed and replaced with getResources

    • info

      the endpoint scheme security XF-Api-Key was added to the API

    • info

      the endpoint scheme security XF-OAuth2 was added to the API

    • info

      added the new optional header request parameter XF-Api-User to all path's operations

    • info

      added the new optional query request parameter api_bypass_permissions to all path's operations

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

  • 0f490cfb7931Revision changes
    • info

      api tag Resources added

    • info

      api tag resources removed

    • info

      added the new optional query request parameter creator_id

    • info

      added the new optional query request parameter direction

    • info

      added the new optional query request parameter order

    • info

      added the new optional query request parameter page

    • info

      added the new optional query request parameter prefix_id

    • info

      added the new optional query request parameter type

    • info

      added the media type application/json for the response with the status