Get API resources

GET /api/resources

Get API resources in the current tenant with pagination.

Query parameters

  • includeScopes string

    If it's provided with a truthy value (true, 1, yes), the scopes of each resource will be included in the response.

  • page integer

    Page number (starts from 1).

    Minimum value is 1. Default value is 1.

  • page_size integer

    Entries per page.

    Minimum value is 1. Default value is 20.

Responses

  • • 200 application/json

    An array of resources.

    Hide response attributes Show response attributes object
    • id string Required

      Minimum length is 1, maximum length is 21.

    • name string Required

      Minimum length is 1.

    • indicator string Required

      Minimum length is 1.

    • isDefault boolean Required
    • accessTokenTtl number Required
    • scopes array[object]
      Hide scopes attributes Show scopes attributes object
      • id string Required

        Minimum length is 1, maximum length is 21.

      • resourceId string Required

        Minimum length is 1, maximum length is 21.

      • name string Required

        Minimum length is 1, maximum length is 256.

      • description string | null Required
      • createdAt number Required
  • • 400

    Bad Request

  • • 401

    Unauthorized

  • • 403

    Forbidden

GET /api/resources 
curl \
 -X GET https://[tenant_id].logto.app/api/resources
Response examples (200) 
[
  {
    "id": "string",
    "name": "string",
    "indicator": "string",
    "isDefault": true,
    "accessTokenTtl": 42.0,
    "scopes": [
      {
        "id": "string",
        "resourceId": "string",
        "name": "string",
        "description": "string",
        "createdAt": 42.0
      }
    ]
  }
]