---
title: "View agent"
method: GET
path: "/v1/Agents/{id}"
tags: ["Agents"]
---

# View agent

`GET /v1/Agents/{id}`

Find a single agent by ID.

## Path parameters

- `id` integer, required

## Response `200`

OK

- RevWebAPIModelsGetOrSearchOfRevAppModelsAgent
  - `ok` boolean
  - `agent_id` integer — Primary identifier for this agent.
  - `parent_agent_id` integer — Foreign identifier indicating a parent agent.
  - `agent_type_id` integer — Foreign identifier indicating the type of agent.
  - `default_commission_plan_id` integer — Foreign identifier indicating the commission plan assigned to the agent.
  - `address_id` integer — Foreign identifier indicating the address for this agent.
  - `account_number` string — Customizable account identifier.
  - `name` string — Name of the agent or agency.
  - `email` string — Primary contact email (or emails separated by comma).
  - `phone` string — Primary contact phone number.
  - `fax` string — Primary contact fax number.
  - `status` 'ACTIVE' | 'INACTIVE', required — Current status of the agent.
  - `show_unrestricted_packages` boolean — Indicates whether the agent can see packages that are not restricted any particular agent. Even when enabled, packages restricted to a different agent are still hidden.
  - `tax_identification_number` string — Tax identification number (i.e. SSN, EIN).
  - `company_bill_profile_id` integer — Foreign identifier indicating the bill profile associated with this agent.
  - `created_date` string, date-time — Date and time this agent was created.
  - `created_by` integer — Foreign identifier indicating the user who created this agent.
  - `logo_file_id` integer — Foreign identifier indicating the file that contains the agent logo.
  - `contacts` RevAppModelsContact[] — List of contacts for the agent.
    - `contact_id` integer — Primary identifier for this contact.
    - `name` string, required — Name of contact. Can be full or partial name.
    - `email` string — Email address or addresses for which to contact this person. (for multiple emails, separate by comma)
    - `company` string — Name of the company this person works for.
    - `customer_id` integer — Foreign identifier for the account this contact is associated with.
    - `agent_id` integer — Foreign identifier for the agent this contact is associated with.
    - `created_date` string, date-time — Date and time this contact was created.
    - `title` string — A title for which this contact holds.
    - `position` string — A position for which this contact holds.
    - `fax` string — Telephone number to use for facsimile transmission.
    - `phone` string — Primary phone number that can be used to contact the person.
    - `comments` string — Comments or notes about the person for internal use.
    - `mobile` string — A mobile telephone number from which the person can be contacted.
    - `contact_type_id` integer — Foreign identifier for the type of contact represented.
    - `fields` RevAppModelsFieldValue[] — List of custom fields and their values.
      - `field_id` integer — Primary identifier for this custom field.
      - `label` string — User-defined identifier representing the custom field.
      - `value` string — Value of the custom field.
      - `links` RevAppComponentsLink[]
        - `rel` string
        - `href` string
    - `address` RevAppModelsContactAddress
      - `line_1` string — First line of address. (i.e. Street Number, Street Name, Post Direction)
      - `line_2` string — Second line of address. (i.e. Apt, Unit, Floor)
      - `city` string — City or township of the address.
      - `state_or_province` string — State if USA, Province for some other countries.
      - `postal_code` string — Zip for USA (5-digit), can be longer for other countries.
      - `postal_code_extension` string — Zip+4 for USA
      - `links` RevAppComponentsLink[]
        - `rel` string
        - `href` string
    - `links` RevAppComponentsLink[]
      - `rel` string
      - `href` string
  - `fields` RevAppModelsFieldValue[] — List of custom fields and their values.
    - `field_id` integer — Primary identifier for this custom field.
    - `label` string — User-defined identifier representing the custom field.
    - `value` string — Value of the custom field.
    - `links` RevAppComponentsLink[]
      - `rel` string
      - `href` string
  - `links` RevAppComponentsLink[]
    - `rel` string
    - `href` string

## Other responses

- `404` — NotFound
- `500` — InternalServerError

---

[API](https://skmtc.net/rev-io/apis/rev-io-api.md) · [All operations](https://skmtc.net/rev-io/apis/rev-io-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/rev-io/rev-io-api/revisions/135571434f6c/schema)