Get a contact by ID

Retrieve detailed information about a specific contact in your Quo workspace using the contact’s unique identifier.

GET /v1/contacts/{id}

Get a contact by ID

cURL

curl --request GET \
  --url https://dev-public-api.openphone.dev/v1/contacts/{id} \
  --header 'Authorization: <api-key>'

200

{
  "data": {
    "id": "664d0db69fcac7cf2e6ec",
    "externalId": "664d0db69fcac7cf2e6ec",
    "source": "public-api",
    "sourceUrl": "https://openphone.co/contacts/664d0db69fcac7cf2e6ec",
    "defaultFields": {
      "company": "Quo",
      "emails": [
        {
          "name": "company email",
          "value": "[e-mail]",
          "id": "acb123"
        }
      ],
      "firstName": "John",
      "lastName": "Doe",
      "phoneNumbers": [
        {
          "name": "company phone",
          "value": "[phone]",
          "id": "acb123"
        }
      ],
      "role": "Sales"
    },
    "customFields": [
      {
        "name": "Inbound Lead",
        "type": "multi-select",
        "value": [
          "option1",
          "option2"
        ],
        "key": "inbound-lead",
        "id": "66d0d87d534de8fd1c433cec3"
      }
    ],
    "createdAt": "2022-01-01T00:00:00Z",
    "updatedAt": "2022-01-01T00:00:00Z",
    "createdByUserId": "US123abc"
  }
}

{
  "message": "<string>",
  "code": "<string>",
  "status": 123,
  "docs": "<string>",
  "title": "<string>",
  "description": "<string>",
  "trace": "<string>",
  "errors": [
    {
      "path": "<string>",
      "message": "<string>",
      "schema": {
        "type": "<string>"
      },
      "value": "<unknown>"
    }
  ]
}

{
  "message": "<string>",
  "code": "<string>",
  "status": 123,
  "docs": "<string>",
  "title": "<string>",
  "trace": "<string>",
  "errors": [
    {
      "path": "<string>",
      "message": "<string>",
      "schema": {
        "type": "<string>"
      },
      "value": "<unknown>"
    }
  ]
}

{
  "message": "<string>",
  "code": "<string>",
  "status": 123,
  "docs": "<string>",
  "title": "<string>",
  "description": "<string>",
  "trace": "<string>",
  "errors": [
    {
      "path": "<string>",
      "message": "<string>",
      "schema": {
        "type": "<string>"
      },
      "value": "<unknown>"
    }
  ]
}

{
  "message": "<string>",
  "code": "<string>",
  "status": 123,
  "docs": "<string>",
  "title": "<string>",
  "trace": "<string>",
  "errors": [
    {
      "path": "<string>",
      "message": "<string>",
      "schema": {
        "type": "<string>"
      },
      "value": "<unknown>"
    }
  ]
}

{
  "message": "<string>",
  "code": "<string>",
  "status": 123,
  "docs": "<string>",
  "title": "<string>",
  "trace": "<string>",
  "errors": [
    {
      "path": "<string>",
      "message": "<string>",
      "schema": {
        "type": "<string>"
      },
      "value": "<unknown>"
    }
  ]
}

{
  "message": "<string>",
  "code": "<string>",
  "status": 123,
  "docs": "<string>",
  "title": "<string>",
  "trace": "<string>",
  "errors": [
    {
      "path": "<string>",
      "message": "<string>",
      "schema": {
        "type": "<string>"
      },
      "value": "<unknown>"
    }
  ]
}

Authorizations

Authorization · string · header · required

Path Parameters

id · string · required

The unique identifier of the contact.

Pattern: ^(.*)$

Example:

"66d0d87e8dc1211467372303"

Response

200

application/json

OK

data · object · required

Show child attributes