---
title: "Get scope details"
method: GET
path: "/scopes/{scope}"
---

# Get scope details

`GET /scopes/{scope}`

Returns details of a scope. Returns full scope information (including quotas and settings) if the user is a scope member.

## Path parameters

- `scope` string, required — The name of a scope. This must not be @ prefixed.

## Response `200`

OK

- union
  - Scope — Partial scope information.
    - `scope` string, required — The name of a scope. This must not be @ prefixed.
    - `description` string, required — The description of the scope.
    - `createdAt` string, date-time, required — The date and time when the scope was created.
    - `updatedAt` string, date-time, required — The date and time when the scope was last updated.
  - FullScope — Full scope information (includes quotas and settings).
    - `scope` string, required — The name of a scope. This must not be @ prefixed.
    - `description` string, required — The description of the scope.
    - `creator` User, required — Public user information.
      - `id` string, uuid, required — The ID of a user.
      - `name` string, required — The user's display name.
      - `avatarUrl` string, required — The URL to the user's avatar.
      - `githubId` integer, nullable — The user's GitHub ID.
      - `createdAt` string, date-time, required — The date and time when the user profile was created.
      - `updatedAt` string, date-time, required — The date and time when the user profile was last updated.
    - `quotas` object, required
      - `packageUsage` integer — The number of packages in the scope.
      - `packageLimit` integer — The maximum number of packages allowed in the scope.
      - `newPackagePerWeekUsage` integer — The number of new packages created in the scope in the last week.
      - `newPackagePerWeekLimit` integer — The maximum number of new packages allowed to be created in the scope in a week.
      - `publishAttemptsPerWeekUsage` integer — The number of times packages in the scope have been published in the last week.
      - `publishAttemptsPerWeekLimit` integer — The maximum number of times packages in the scope can be published in a week.
    - `ghActionsVerifyActor` boolean, required — Whether to verify the actor of a GitHub Actions run when authenticating publishing with a GitHub Actions OIDC token.
    - `requirePublishingFromCI` boolean, required — Whether to require publishing from a CI environment. This disables publishing from a local environment.
    - `createdAt` string, date-time, required — The date and time when the scope was created.
    - `updatedAt` string, date-time, required — The date and time when the scope was last updated.

## Other responses

- `400` — Invalid request
- `404` — Scope not found

---

[API](https://skmtc.net/jsr-io/apis/jsr-api.md) · [All operations](https://skmtc.net/jsr-io/apis/jsr-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/jsr-io/jsr-api/versions/3d37ac9b68f7/schema)