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

# Unipile: Get Attendee

> Get one chat attendee (messaging contact) by id. Includes SDK V2 guidance, input constraints, response fields, and Deepline credit cost.

Get one chat attendee (messaging contact) by id.

> [!NOTE]
>
> Tool ID: `unipile_get_attendee`

## Run this action

Use the TypeScript SDK for one call. Use `ctx.tools.execute(...)` inside a Play for durable calls, scheduled calls, or CSV processing.

```ts theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
import { Deepline } from 'deepline';

const deepline = await Deepline.connect();
const result = await deepline.tools.execute(
  'unipile_get_attendee',
  {
    "id": "id_123"
  },
);

console.log(result.toolResponse.raw);
```

### CLI

```bash theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
deepline tools execute unipile_get_attendee --input '{
  "id": "id_123"
}' --json
```

## Example response

The SDK returns this shape at `result.toolResponse.raw`. The example values illustrate the response.

```json theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
{
  "data": {
    "id": "id_123",
    "account_id": "123456789",
    "provider_id": "provider_123",
    "name": "Example",
    "is_self": 1,
    "object": "ChatAttendee"
  }
}
```

Use `deepline describe unipile_get_attendee --json` for the latest machine-readable contract.

## Input reference

The id of the wanted attendee.

| Name | Type | Required | Default | Details |
| - | - | - | - | - |
| `payload.id` | `string` | Yes | — | The id of the wanted attendee. |
| `payload.account_id` | `string` | No | — | A filter to target items related to a certain account. |

<details>
  <summary>Show raw input schema</summary>

  ### Input JSON Schema

  ```json theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
  {
    "type": "object",
    "description": "The id of the wanted attendee.",
    "properties": {
      "id": {
        "type": "string",
        "description": "The id of the wanted attendee."
      },
      "account_id": {
        "type": "string",
        "description": "A filter to target items related to a certain account."
      }
    },
    "required": [
      "id"
    ],
    "additionalProperties": false
  }
  ```
</details>

## Output reference

Standard tool result payload.

| Name | Type | Required | Default | Details |
| - | - | - | - | - |
| `result.data` | `object` | Yes | — | Provider response payload. |
| `result.data.id` | `string` | Yes | — | A unique identifier. Minimum length: 1. |
| `result.data.account_id` | `string` | Yes | — | A unique identifier. Minimum length: 1. |
| `result.data.provider_id` | `string` | Yes | — | — |
| `result.data.name` | `string` | Yes | — | — |
| `result.data.is_self` | `1 \| 0` | Yes | — | — |
| `result.data.hidden` | `1 \| 0` | No | — | — |
| `result.data.picture_url` | `string` | No | — | — |
| `result.data.profile_url` | `string` | No | — | — |
| `result.data.specifics` | `object` | No | — | Provider specific additional data. |
| `result.data.specifics.provider` | `"LINKEDIN"` | Yes | — | — |
| `result.data.specifics.member_urn` | `string` | Yes | — | — |
| `result.data.specifics.occupation` | `string` | No | — | — |
| `result.data.specifics.network_distance` | `"SELF" \| "DISTANCE_1" \| "DISTANCE_2" \| "DISTANCE_3" \| "OUT_OF_NETWORK"` | No | — | — |
| `result.data.specifics.pending_invitation` | `boolean` | No | — | — |
| `result.data.specifics.location` | `string` | No | — | — |
| `result.data.specifics.headline` | `string` | No | — | — |
| `result.data.specifics.contact_info` | `object` | No | — | — |
| `result.data.specifics.contact_info.emails` | `array` | No | — | — |
| `result.data.specifics.contact_info.phone_numbers` | `array` | No | — | — |
| `result.data.specifics.contact_info.websites` | `array` | No | — | — |
| `result.data.specifics.contact_info.social_handles` | `array` | No | — | — |
| `result.data.specifics.contact_info.social_handles[].type` | `string` | Yes | — | — |
| `result.data.specifics.contact_info.social_handles[].name` | `string` | Yes | — | — |
| `result.data.specifics.public_identifier` | `string` | Yes | — | — |
| `result.data.specifics.relationship_status` | `object` | Yes | — | — |
| `result.data.specifics.relationship_status.following` | `boolean` | No | — | — |
| `result.data.specifics.relationship_status.followed_by` | `boolean` | No | — | — |
| `result.data.specifics.relationship_status.has_received_invitation` | `boolean` | No | — | — |
| `result.data.specifics.relationship_status.has_sent_invitation` | `boolean` | No | — | — |
| `result.data.object` | `"ChatAttendee"` | Yes | — | Allowed: `ChatAttendee`. |
| `result.meta` | `object` | No | — | Additional response metadata (status, paging). |

<details>
  <summary>Show raw output schema</summary>

  ### Output JSON Schema

  ```json theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
  {
    "type": "object",
    "description": "Standard tool result payload.",
    "properties": {
      "data": {
        "type": "object",
        "description": "Provider response payload.",
        "properties": {
          "id": {
            "type": "string",
            "description": "A unique identifier.",
            "minLength": 1
          },
          "account_id": {
            "type": "string",
            "description": "A unique identifier.",
            "minLength": 1
          },
          "provider_id": {
            "type": "string"
          },
          "name": {
            "type": "string"
          },
          "is_self": {
            "anyOf": [
              {
                "type": "number",
                "enum": [
                  1
                ]
              },
              {
                "type": "number",
                "enum": [
                  0
                ]
              }
            ]
          },
          "hidden": {
            "anyOf": [
              {
                "type": "number",
                "enum": [
                  1
                ]
              },
              {
                "type": "number",
                "enum": [
                  0
                ]
              }
            ]
          },
          "picture_url": {
            "type": "string"
          },
          "profile_url": {
            "type": "string"
          },
          "specifics": {
            "description": "Provider specific additional data.",
            "anyOf": [
              {
                "type": "object",
                "properties": {
                  "provider": {
                    "type": "string",
                    "enum": [
                      "LINKEDIN"
                    ]
                  },
                  "member_urn": {
                    "type": "string"
                  },
                  "occupation": {
                    "type": "string"
                  },
                  "network_distance": {
                    "anyOf": [
                      {
                        "type": "string",
                        "enum": [
                          "SELF"
                        ]
                      },
                      {
                        "type": "string",
                        "enum": [
                          "DISTANCE_1"
                        ]
                      },
                      {
                        "type": "string",
                        "enum": [
                          "DISTANCE_2"
                        ]
                      },
                      {
                        "type": "string",
                        "enum": [
                          "DISTANCE_3"
                        ]
                      },
                      {
                        "type": "string",
                        "enum": [
                          "OUT_OF_NETWORK"
                        ]
                      }
                    ]
                  },
                  "pending_invitation": {
                    "type": "boolean"
                  },
                  "location": {
                    "type": "string"
                  },
                  "headline": {
                    "type": "string"
                  },
                  "contact_info": {
                    "type": "object",
                    "properties": {
                      "emails": {
                        "type": "array",
                        "items": {
                          "type": "string"
                        }
                      },
                      "phone_numbers": {
                        "type": "array",
                        "items": {
                          "type": "string"
                        }
                      },
                      "websites": {
                        "type": "array",
                        "items": {
                          "type": "string"
                        }
                      },
                      "social_handles": {
                        "type": "array",
                        "items": {
                          "type": "object",
                          "properties": {
                            "type": {
                              "type": "string"
                            },
                            "name": {
                              "type": "string"
                            }
                          },
                          "required": [
                            "type",
                            "name"
                          ],
                          "additionalProperties": false
                        }
                      }
                    },
                    "additionalProperties": false
                  }
                },
                "required": [
                  "provider",
                  "member_urn"
                ],
                "additionalProperties": false
              },
              {
                "type": "object",
                "properties": {
                  "provider": {
                    "type": "string",
                    "enum": [
                      "INSTAGRAM"
                    ]
                  },
                  "public_identifier": {
                    "type": "string"
                  },
                  "relationship_status": {
                    "type": "object",
                    "properties": {
                      "following": {
                        "type": "boolean"
                      },
                      "followed_by": {
                        "type": "boolean"
                      },
                      "has_received_invitation": {
                        "type": "boolean"
                      },
                      "has_sent_invitation": {
                        "type": "boolean"
                      }
                    },
                    "additionalProperties": false
                  }
                },
                "required": [
                  "provider",
                  "public_identifier",
                  "relationship_status"
                ],
                "additionalProperties": false
              }
            ]
          },
          "object": {
            "type": "string",
            "enum": [
              "ChatAttendee"
            ]
          }
        },
        "required": [
          "id",
          "account_id",
          "provider_id",
          "name",
          "is_self",
          "object"
        ],
        "additionalProperties": false
      },
      "meta": {
        "type": "object",
        "description": "Additional response metadata (status, paging).",
        "additionalProperties": true
      }
    },
    "required": [
      "data"
    ],
    "additionalProperties": false
  }
  ```
</details>

## Deepline cost

* Pricing model: `fixed` (per call).
* Estimated Deepline credits: `0` per pricing unit.
* Provider-native pricing may still exist outside Deepline credit billing.

## Related documentation

* [Unipile provider guide](https://deepline.com/docs/providers/unipile/guide.md)
* [SDK V2 quickstart](https://deepline.com/docs/sdk-v2/quickstart.md)
* [SDK reference](https://deepline.com/docs/sdk-v2/sdk-reference.md)
* [Run tools across a CSV](https://deepline.com/docs/sdk-v2/batch-csv.md)


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