---
agentTools:
  projectIndex: https://clientsuccess.readme.io/v1.0/llms.txt
---

# Get a contact summary

# OpenAPI definition

```json
{
  "openapi": "3.0.0",
  "info": {
    "title": "ClientSuccess API 1.0",
    "description": "This is the ClientSuccess open API for customer/developer use.",
    "contact": {},
    "version": "1.0"
  },
  "servers": [
    {
      "url": "https://api.clientsuccess.com",
      "variables": {}
    }
  ],
  "security": [
    {
      "bearer-key": []
    }
  ],
  "paths": {
    "/v1/clients/{clientId}/contacts/{contactId}": {
      "get": {
        "tags": [
          "Contacts"
        ],
        "summary": "Get a contact summary",
        "description": "",
        "operationId": "Getacontactsummary",
        "parameters": [
          {
            "name": "clientId",
            "in": "path",
            "description": "Id of a Client.",
            "required": true,
            "style": "simple",
            "schema": {
              "type": "integer",
              "example": 1340
            }
          },
          {
            "name": "contactId",
            "in": "path",
            "description": "Id of a Contact.",
            "required": true,
            "style": "simple",
            "schema": {
              "type": "integer",
              "example": 89
            }
          }
        ],
        "responses": {
          "200": {
            "description": "",
            "headers": {},
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Getacontactsummaryresponse"
                },
                "example": {
                  "id": 1234,
                  "clientId": 223344,
                  "name": null,
                  "email": "zachary@bluebird.com",
                  "phone": "null",
                  "mobile": null,
                  "title": null,
                  "preferredName": null,
                  "linkedinUrl": null,
                  "photoUrl": null,
                  "firstName": "Zach",
                  "lastName": "Bird",
                  "executiveSponsor": false,
                  "advocate": false,
                  "champion": false,
                  "starred": false,
                  "keyContact": false,
                  "lastEngagement": null,
                  "engagementCount": 0,
                  "street": null,
                  "city": null,
                  "zip": null,
                  "country": null,
                  "timezone": null,
                  "salesforceId": null,
                  "client": "Test Client",
                  "contactState": null
                }
              }
            }
          }
        },
        "deprecated": false
      }
    }
  },
  "components": {
    "schemas": {
      "Getacontactsummaryresponse": {
        "title": "Getacontactsummaryresponse",
        "required": [
          "id",
          "clientId",
          "name",
          "email",
          "phone",
          "mobile",
          "title",
          "preferredName",
          "linkedinUrl",
          "photoUrl",
          "firstName",
          "lastName",
          "executiveSponsor",
          "advocate",
          "champion",
          "starred",
          "keyContact",
          "lastEngagement",
          "engagementCount",
          "street",
          "city",
          "zip",
          "country",
          "timezone",
          "salesforceId",
          "client",
          "contactState"
        ],
        "type": "object",
        "properties": {
          "id": {
            "type": "integer",
            "format": ""
          },
          "clientId": {
            "type": "integer",
            "format": ""
          },
          "name": {
            "type": "string",
            "nullable": true
          },
          "email": {
            "type": "string"
          },
          "phone": {
            "type": "string"
          },
          "mobile": {
            "type": "string",
            "nullable": true
          },
          "title": {
            "type": "string",
            "nullable": true
          },
          "preferredName": {
            "type": "string",
            "nullable": true
          },
          "linkedinUrl": {
            "type": "string",
            "nullable": true
          },
          "photoUrl": {
            "type": "string",
            "nullable": true
          },
          "firstName": {
            "type": "string"
          },
          "lastName": {
            "type": "string"
          },
          "executiveSponsor": {
            "type": "boolean"
          },
          "advocate": {
            "type": "boolean"
          },
          "champion": {
            "type": "boolean"
          },
          "starred": {
            "type": "boolean"
          },
          "keyContact": {
            "type": "boolean"
          },
          "lastEngagement": {
            "type": "string",
            "nullable": true
          },
          "engagementCount": {
            "type": "integer",
            "format": ""
          },
          "street": {
            "type": "string",
            "nullable": true
          },
          "city": {
            "type": "string",
            "nullable": true
          },
          "zip": {
            "type": "string",
            "nullable": true
          },
          "country": {
            "type": "string",
            "nullable": true
          },
          "timezone": {
            "type": "string",
            "nullable": true
          },
          "salesforceId": {
            "type": "string",
            "nullable": true
          },
          "client": {
            "type": "string"
          },
          "contactState": {
            "type": "string",
            "nullable": true
          }
        },
        "example": {
          "id": 1234,
          "clientId": 223344,
          "name": null,
          "email": "zachary@bluebird.com",
          "phone": "null",
          "mobile": null,
          "title": null,
          "preferredName": null,
          "linkedinUrl": null,
          "photoUrl": null,
          "firstName": "Zach",
          "lastName": "Bird",
          "executiveSponsor": false,
          "advocate": false,
          "champion": false,
          "starred": false,
          "keyContact": false,
          "lastEngagement": null,
          "engagementCount": 0,
          "street": null,
          "city": null,
          "zip": null,
          "country": null,
          "timezone": null,
          "salesforceId": null,
          "client": "Test Client",
          "contactState": null
        }
      }
    },
    "securitySchemes": {
      "bearer-key": {
        "type": "http",
        "scheme": "bearer",
        "bearerFormat": "jwt",
        "description": "Your token"
      }
    }
  },
  "tags": [
    {
      "name": "Contacts",
      "description": ""
    }
  ],
  "x-readme": {
    "explorer-enabled": true,
    "proxy-enabled": true
  },
  "_id": {
    "buffer": {
      "0": 97,
      "1": 185,
      "2": 41,
      "3": 196,
      "4": 88,
      "5": 246,
      "6": 29,
      "7": 0,
      "8": 41,
      "9": 214,
      "10": 49,
      "11": 169
    }
  }
}
```