Sentry Users API

Retrieve user-related information

Documentation

Specifications

Schemas & Data

Other Resources

OpenAPI Specification

sentry-system-users-api-openapi.yml Raw ↑
openapi: 3.1.0
info:
  title: Sentry Alerts Users API
  description: The Alerts API provides endpoints for managing alert rules in Sentry, including creating, retrieving, updating, and deleting metric alert rules and issue alert rules, as well as managing spike protection notification actions.
  version: 0.0.1
  contact:
    name: Sentry Support
    url: https://sentry.io/support/
    email: support@sentry.io
servers:
- url: https://sentry.io/api/0
  description: Sentry Production API
security:
- BearerAuth: []
tags:
- name: Users
  description: Retrieve user-related information
paths:
  /organizations/:
    get:
      operationId: listUserOrganizations
      summary: Sentry List your organizations
      description: Returns a list of organizations available to the authenticated session. This is particularly useful for tokens with access to multiple organizations.
      tags:
      - Users
      parameters:
      - name: owner
        in: query
        description: Restrict results to organizations owned by the authenticated user.
        schema:
          type: boolean
      - name: cursor
        in: query
        description: Pagination cursor.
        schema:
          type: string
      responses:
        '200':
          description: A list of organizations.
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Organization'
        '401':
          description: Unauthorized.
components:
  schemas:
    Organization:
      type: object
      properties:
        id:
          type: string
        slug:
          type: string
        name:
          type: string
        dateCreated:
          type: string
          format: date-time
        status:
          type: object
          properties:
            id:
              type: string
            name:
              type: string
        isEarlyAdopter:
          type: boolean
        avatar:
          type: object
          properties:
            avatarType:
              type: string
            avatarUuid:
              type: string
              nullable: true
      required:
      - id
      - slug
      - name
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      description: Authentication token for the Sentry API.