> ## Documentation Index
> Fetch the complete documentation index at: https://docs.y.uno/llms.txt
> Use this file to discover all available pages before exploring further.

# List Succeeded Groups

> Lists the succeeded groups of an account, to reference by group_id from SUCCEEDED_GROUP routing outputs.

Lists the succeeded groups saved on an account: groups of success sub-statuses you reference with `status: "SUCCEEDED_GROUP"` in a routing output, to react to an authorization the provider holds for review (`PENDING_IN_REVIEW`) differently from a plain approval. Use the `id` of a group as `group_id` — see [Outcome groups](/reference/organizations/routing/routing-resource-shape#outcome-groups).

The endpoint is read only. Succeeded groups are created in the dashboard.

### Query Parameters

**account\_id** `string` *required*

The account to list groups for. Must belong to the organization your API credentials are scoped to.

### Response

An array with the groups of the account, or an empty array if it has none. Each group contains:

**id** `integer`

The value to send as `group_id`.

**name** `string`

The group's name, as shown in the dashboard and returned as `group_name` on routing outputs.

**type** `enum`

Always `SUCCEEDED_GROUP`, the output `status` the group is used with.

**succeeded\_types** `string[]`

The group's members. Today the only success sub-status that can be grouped is `PENDING_IN_REVIEW`. See [Transaction codes](/reference/payments/status-and-response-codes/transaction#succeeded-status).

```bash cURL theme={"theme":{"light":"github-dark","dark":"github-dark-dimmed"}}
curl -X GET 'https://api.y.uno/v1/routing/succeeded-groups?account_id=7825fc5e-e50a-4248-9ae8-5d3786afb0be' \
  -H 'public-api-key: <YOUR_PUBLIC_KEY>' \
  -H 'private-secret-key: <YOUR_SECRET_KEY>'
```

```json 200 OK theme={"theme":{"light":"github-dark","dark":"github-dark-dimmed"}}
[
  {
    "id": 430,
    "name": "Pending review",
    "type": "SUCCEEDED_GROUP",
    "succeeded_types": ["PENDING_IN_REVIEW"]
  }
]
```

```json 400 Bad Request — Missing account_id theme={"theme":{"light":"github-dark","dark":"github-dark-dimmed"}}
{
  "code": "ROUTING_VALIDATION_FAILED",
  "messages": ["account_id is required."]
}
```

### Errors

| HTTP | `code` | When |
| - | - | - |
| `400` | `ROUTING_VALIDATION_FAILED` | Missing `account_id` query parameter. |
| `400` | `INVALID_ACCOUNT_ID` | `account_id` belongs to an organization your API key doesn't own. |
| `401` | `NOT_AUTHENTICATED` | Missing `public-api-key` or `private-secret-key` header. |
| `401` | `INVALID_CREDENTIALS` | Wrong key pair, or a Dashboard **Customized API key** was used. Use an account key or organization key instead. |
| `502` | `ROUTING_UPSTREAM_ERROR` | The routing service could not be reached. Retry the request. |


## OpenAPI

````yaml openapi/organizations/routing/list-succeeded-groups.json GET /routing/succeeded-groups
openapi: 3.1.0
info:
  title: Routing API - List Succeeded Groups
  version: 1.0.0
servers:
  - url: https://api-sandbox.y.uno/v1
    description: Sandbox
  - url: https://api.y.uno/v1
    description: Production (US)
  - url: https://api.eu.y.uno/v1
    description: Production (EMEA)
security:
  - sec0: []
    sec1: []
paths:
  /routing/succeeded-groups:
    get:
      summary: List Succeeded Groups
      description: >-
        Lists the succeeded groups of an account, to reference by group_id from
        SUCCEEDED_GROUP routing outputs. Read only.
      operationId: list-succeeded-groups
      parameters:
        - name: account_id
          in: query
          required: true
          schema:
            type: string
            format: uuid
          description: >-
            Account to list groups for. Must belong to the organization of your
            API credentials.
      responses:
        '200':
          description: The groups of the account, or an empty array if it has none.
          content:
            application/json:
              schema:
                type: array
                items:
                  type: object
                  properties:
                    id:
                      type: integer
                      example: 430
                      description: The value to send as group_id in a routing output.
                    name:
                      type: string
                      example: Pending review
                    type:
                      type: string
                      enum:
                        - SUCCEEDED_GROUP
                      description: >-
                        Always SUCCEEDED_GROUP, the output status the group is
                        used with.
                    succeeded_types:
                      type: array
                      items:
                        type: string
                      example:
                        - PENDING_IN_REVIEW
                      description: >-
                        Members of the group. Today the only success sub-status
                        that can be grouped is PENDING_IN_REVIEW.
        '400':
          description: >-
            Bad Request. `ROUTING_VALIDATION_FAILED` when `account_id` is
            missing, `INVALID_ACCOUNT_ID` when it belongs to a different
            organization.
          content:
            application/json:
              schema:
                type: object
                properties:
                  code:
                    type: string
                    example: ROUTING_VALIDATION_FAILED
                  messages:
                    type: array
                    items:
                      type: string
                    example:
                      - account_id is required.
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                type: object
                properties:
                  code:
                    type: string
                    example: NOT_AUTHENTICATED
                  messages:
                    type: array
                    items:
                      type: string
                    example:
                      - Not authenticated
        '502':
          description: Bad Gateway
          content:
            application/json:
              schema:
                type: object
                properties:
                  code:
                    type: string
                    example: ROUTING_UPSTREAM_ERROR
                  messages:
                    type: array
                    items:
                      type: string
                    example:
                      - routing service unavailable.
components:
  securitySchemes:
    sec0:
      type: apiKey
      in: header
      name: PUBLIC-API-KEY
      x-default: <Your PUBLIC-API-KEY>
    sec1:
      type: apiKey
      in: header
      name: PRIVATE-SECRET-KEY
      x-default: <Your PRIVATE-SECRET-KEY>

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.