v1

latestOpenAPI 3.0.32026-07-14490228.1 KB

Get Person By ID

This endpoint retrieves a person owned by the client.

get/people/{id}

Path parameters

idinteger required

The ID used to identify the person.

Response

200

Example response

{
  "data": {
    "id": 1,
    "phone_number": "+15555555551",
    "added_at": "2020-08-01 07:47:04",
    "source": "inbound_call",
    "segments": [
      {
        "id": 1,
        "name": "Test Segment 1",
        "type": "static",
        "status": "active",
        "pivot": {
          "person_id": 1,
          "segment_id": 1,
          "added_at": "2020-09-19 01:01:58"
        }
      }
    ],
    "numbers": [
      {
        "id": 1,
        "name": "Test Number 1",
        "number": "+15555555551",
        "status": "active",
        "catchall_sequence_id": 1,
        "client_id": 1,
        "pivot": {
          "person_id": 1,
          "number_id": 1,
          "added_at": "2020-08-01 07:47:04",
          "source": "inbound_call"
        }
      }
    ],
    "attributes": [
      {
        "id": 1,
        "name": "Phone Number",
        "type": "string",
        "scope": "system",
        "length": 15,
        "values_type": "open",
        "status": "active",
        "pivot": {
          "person_id": 1,
          "attribute_id": 1,
          "value": "+15555555551",
          "created_at": "2020-08-07 17:55:01",
          "updated_at": "2021-06-15 17:35:46"
        }
      }
    ],
    "webform_submissions": [
      {
        "id": 1,
        "person_id": 1,
        "call_id": 1,
        "ip_address": "0.0.0.0",
        "webform_id": 1,
        "created_at": "2020-09-19 01:01:58",
        "webform": {
          "id": 1,
          "name": "Test Webform 1",
          "guid": "4f4616c0-fa0e-11ea-8b77-959e9d0a1123",
          "status": "active",
          "button_text": "Submit",
          "captcha_type": "none",
          "sequence_id": 1,
          "success_type": "send_message",
          "success_message": "Thank you, we'll be calling you shortly to connect you."
        }
      }
    ],
    "recordings": [
      {
        "id": 1,
        "person_id": 1,
        "call_sid": "CAe2a044a9839dcf45b19bc2b780a1fcc8",
        "call_id": 1,
        "number_id": 1,
        "client_id": 1,
        "sequence_id": 1,
        "sequence_block_id": 1,
        "status": "active",
        "recording_sid": "REabf48816663ff31d20422eb74ac9c5aa",
        "recording_url": "https://api.twilio.com/2010-04-01/Accounts/AC75e1175473966c710125c808ee82dc1c/Recordings/REabf48816663e831d2304eeb74accc2aa",
        "recording_status": "completed",
        "recording_channels": 1,
        "recording_start_time": "Tue, 22 Dec 2020 19:35:27 +0000",
        "recording_duration": 5,
        "transcription_sid": "TR8faf05cdd7d9e66c63a111b92518f9d6",
        "transcription_type": "fast",
        "transcription_url": "https://api.twilio.com/2010-04-01/Accounts/AC75e1175473966c710125c808ee82dc1c/Recordings/REabf48816663e831d2304eeb74accc2aa/Transcriptions/TR8faf05cdd7d9e66c63a111b92518f9d6",
        "transcription_status": "completed",
        "created_at": "2020-12-22 19:35:27",
        "updated_at": "2020-12-22 19:35:35",
        "sequence": {
          "id": 1,
          "name": "Test Sequence",
          "status": "active",
          "number_id": 10
        }
      }
    ]
  }
}