---
title: "List all roles in an organization"
method: GET
path: "/v1/roles"
tags: ["Roles"]
---

# List all roles in an organization

`GET /v1/roles`

## Request

- Base URL: `https://api.tetrascience.com`
- URL: `https://api.tetrascience.com/v1/roles`
- Auth: API key in header `ts-auth-token` and API key in header `x-org-slug`

## Query parameters

- `pageNumber` number
- `pageSize` number
- `search` string

## Response `200`

Responding with list of roles

- union
  - object[]
    - `id` Id (unresolved $ref)
    - `name` string
    - `description` string
    - `organizationId` Id (unresolved $ref)
    - `organizationSlug` Schema (unresolved $ref)
    - `ssoGroupMappings` string[]
    - `enabled` boolean
    - `createdAt` CreatedAt (unresolved $ref)
    - `policyScopes` string[]
    - `permissions` object[]
      - `resource` 'search' | 'sqlQueries' | 'sqlCredentials' | 'projects' | 'pipelines' | 'artifacts' | 'idsArtifacts' | 'dataRetention' | 'dataSources' | 'healthMonitoring' | 'jobsMonitoring' | 'attributeManagement' | 'myAccount' | 'administration' | 'auditTrail' | 'dataApp' | 'dataAppProvider' | 'inference' | 'aiArtifacts' | 'artifactVersionManager' | 'tenantManagement' | 'connectorLogs' | 'observability' | 'mockApi' | 'roleDirectory' | 'certificates' | 'dataPackages' | 'platformEvents' | 'integrationHealth' | 'dataAppWorkspace' | 'artifactReadme' | 'artifactFiles' | 'fileMetadata' | 'lakehouseConfig' | 'workflowRuns' | 'fileLinkIntegrations' | 'bulkActions' | 'sqlAccess' | 'microFileUpload' | 'microFileDelete' | 'microBulkActionsLabel' | 'microPipelinePages' | 'microAgentInstall' | 'microSharedSettings', required
      - `action` 'view' | 'create' | 'edit' | 'full', required
  - object
    - `total` number
    - `count` number
    - `roles` object[]
      - `id` Id (unresolved $ref)
      - `name` string
      - `description` string
      - `organizationId` Id (unresolved $ref)
      - `organizationSlug` Schema (unresolved $ref)
      - `ssoGroupMappings` string[]
      - `enabled` boolean
      - `createdAt` CreatedAt (unresolved $ref)
      - `policyScopes` string[]
      - `permissions` object[]
        - `resource` 'search' | 'sqlQueries' | 'sqlCredentials' | 'projects' | 'pipelines' | 'artifacts' | 'idsArtifacts' | 'dataRetention' | 'dataSources' | 'healthMonitoring' | 'jobsMonitoring' | 'attributeManagement' | 'myAccount' | 'administration' | 'auditTrail' | 'dataApp' | 'dataAppProvider' | 'inference' | 'aiArtifacts' | 'artifactVersionManager' | 'tenantManagement' | 'connectorLogs' | 'observability' | 'mockApi' | 'roleDirectory' | 'certificates' | 'dataPackages' | 'platformEvents' | 'integrationHealth' | 'dataAppWorkspace' | 'artifactReadme' | 'artifactFiles' | 'fileMetadata' | 'lakehouseConfig' | 'workflowRuns' | 'fileLinkIntegrations' | 'bulkActions' | 'sqlAccess' | 'microFileUpload' | 'microFileDelete' | 'microBulkActionsLabel' | 'microPipelinePages' | 'microAgentInstall' | 'microSharedSettings', required
        - `action` 'view' | 'create' | 'edit' | 'full', required

## Other responses

- `401`: Invalid token
- `403`: Caller is not authorized to perform this action
- `404`: Organization not found

---

[API](https://skmtc.dev/tetrascience/apis/administration.md) - [All operations](https://skmtc.dev/tetrascience/apis/administration/llms.txt) - [OpenAPI document](https://skmtc.dev/tetrascience/apis/administration/revisions/c1c829febcc5?raw)