# Get the prospect interaction outcomes for an interaction type

`GET /api/members/prospects/interaction-outcomes/{type}`

- **Success:** `200 OK`
- **Products:** not restricted by product
- **Features:** Prospecting (`PROSPECTS`)

HTML version: [Get the prospect interaction outcomes for an interaction type](https://support.gladstonesoftware.cloud/reference/members/get-the-prospect-interaction-outcomes-for-an-interaction-type)

## Overview

Returns the outcomes you are allowed to record against one prospect interaction type. A prospect is a sales lead — someone being followed up as a potential joiner — held as a member record and identified by a member id. The outcome is how the call, task or appointment ended.

The `{type}` you pass must be an `id` taken from the response of `GET /api/members/prospects/interaction-types`. Outcomes are grouped by interaction type, and this endpoint returns a flat list of only the outcomes valid for the type you asked for, with no intermediate grouping. An id no type matches returns an empty array rather than an error.

The `id` values here are what you send as `outcomeOfInteractionTypeId` on `POST /api/members/prospects/{memberId}/interactions`. Because outcomes are scoped to a type, an outcome fetched for one interaction type is not necessarily valid for another — fetch them per type rather than pooling them. The create call rejects an outcome it cannot find with a 422.

Only outcomes flagged active are returned, ordered by `description`. They are configuration data held in your Gladstone system rather than a fixed list, so read them at runtime instead of hard-coding them.

## Endpoint

`GET {base_url}/api/members/prospects/interaction-outcomes/{type}`

`{base_url}` is the environment URL issued to your integration. See [Authenticating with Gladstone APIs](../../guides/authenticating-with-gladstone-apis.md).

## Path parameters

| Name | Type | Required | Description |
|------|------|----------|-------------|
| `type` | string | Yes | The `id` of the interaction type whose outcomes you want, taken from the `[].id` field of `GET /api/members/prospects/interaction-types`. Send it exactly as that endpoint returned it. If it arrives empty the endpoint returns 400 `An interaction type is required.` |

## Sample request

```bash title="cURL"
curl -X GET '{base_url}/api/members/prospects/interaction-outcomes/{type}' \
  -H 'Authorization: Bearer {accessToken}' \
  -H 'X-Use-SSO: true'
```

## Response fields

| Field | Type | Description |
|-------|------|-------------|
| `[].id` | integer (int32) | The identifier of the outcome, and the value you send as `outcomeOfInteractionTypeId` when recording an interaction with `POST /api/members/prospects/{memberId}/interactions`. Note this one is an integer, unlike the interaction type and sub type ids, which are strings. |
| `[].description` | string | The outcome's name as configured on the system. Results are ordered by this field. Show `translations` instead when you know the reader's language. |
| `[].translations` | array of object | The outcome's text translated into each culture configured on the system. Returned as an empty array, never null, when no translations are held for the outcome. |
| `[].translations[].type` | string | The record type the translation belongs to. Only the outcome's own `ProspectInteractionOutcome` translations are returned, so every entry here relates to the outcome it is nested under. |
| `[].translations[].culture` | string | The culture the `text` belongs to, used to pick the variant matching your user's language. |
| `[].translations[].text` | string | The translated text for this culture. Display this in place of `description` when you hold a translation for the culture you are rendering in. |

## Sample response

```json title="200 OK"
[
  {
    "id": 12345,
    "description": "string",
    "translations": [
      {
        "type": "string",
        "culture": "string",
        "text": "string"
      }
    ]
  }
]
```

## Errors

| Status | Meaning | When |
|--------|---------|------|
| `400` | Bad request | The `{type}` path segment is empty or whitespace. The body is `An interaction type is required.` |
| `500` | Internal server error | |