---
title: "Get Group Mappings"
method: GET
path: "/v1/instance/group-mappings/"
tags: ["Instance", "Group Mappings"]
---

# Get Group Mappings

`GET /v1/instance/group-mappings/`

## Request

- Base URL: `https://logfire-api.pydantic.dev/api`
- URL: `https://logfire-api.pydantic.dev/api/v1/instance/group-mappings/`
- Auth: OAuth 2
  - Authorization code: `api/oauth/authorize`
  - Token URL: `/api/oauth/token` scopes: `instance:admin`
- TypeScript: <https://skmtc.dev/pydantic/apis/pydantic-logfire-api/docs/v1/instance/group-mappings/get.ts> (a function with typed inputs; its response is checked against the schema)

Return the group-organization mapping stored in `platform_config` (self-hosted admin only).

When `api_mapping_status` is `overridden_by_environment`, the returned mapping is stored but
is not used for synchronization. The environment-configured mapping is effective, and PUT
requests return 409.

## Response `200`

Successful Response

- GroupOrganizationMappingStatusRead
  - `group_organization_mapping` GroupOrganizationMapping[], required
    - `group_id` string, required
    - `organization_roles` OrganizationRoleDefinition[], required
      - `organization_name` string, required
      - `role` string, required
      - `project_roles` ProjectRoleDefinition[]
        - `project_name` string, required
        - `role` string, required
  - `api_mapping_status` 'active' | 'overridden_by_environment', required

## Other responses

- `429`: Rate limit exceeded

---

[API](https://skmtc.dev/pydantic/apis/pydantic-logfire-api.md) - [All operations](https://skmtc.dev/pydantic/apis/pydantic-logfire-api/llms.txt) - [OpenAPI document](https://skmtc.dev/pydantic/apis/pydantic-logfire-api/revisions/7996e45256f4?raw)