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

# Get Client

> Documentation for the Get Client action for Intakeq

![images/intakeq.svg](https://mintcdn.com/morfhealth/EU2WCxuXGIUQcziR/images/intakeq.svg?fit=max\&auto=format\&n=EU2WCxuXGIUQcziR\&q=85\&s=191a6c088f13edff5cd7f23a84babb49)

# Parameters

**Action** `Parameters`

**parameters**

**Client ID** `int64` *required*

`ID`
This field maps to the destination API `client_id` field.

```json Result Object Example theme={null}
{
  "$result_object_key": {
    "additional_information": "test",
    "address": "123 Main St, Anytown, USA 12345",
    "archived": false,
    "billing_type": null,
    "city": "Anytown",
    "client_id": 42,
    "country": "USA",
    "created_at": "2024-02-25T23:24:31.585Z",
    "credit_balance": 0,
    "custom_fields": [
      {
        "field_id": "rjrx",
        "text": "Intake Concern",
        "value": "AB1"
      }
    ],
    "date_of_birth": "2016-03-21T04:48:00.368Z",
    "email_address": "ettore@bugatti.com",
    "external_client_id": "a7699305-7142-4599-a661-717b6bcd3305",
    "first_name": "Ettore",
    "gender": "Female",
    "guid": "dd67fe12-2eea-4776-b5b0-91248102da43",
    "home_phone": "(222) 222-2222",
    "last_activity_at": "2024-02-25T23:24:31.585Z",
    "last_activity_name": "Created Appt",
    "last_name": "Bugatti",
    "last_updated_at": "2024-02-25T23:25:01.675Z",
    "linked_clients": [
      {
        "client_number": 42,
        "relationship_type": null
      }
    ],
    "marital_status": "Married",
    "middle_name": "",
    "mobile_phone": "(222) 222-2222",
    "name": "Ettore Bugatti",
    "parent_client_id": "412421",
    "phone_number": "5554016515",
    "postal_code": "12345",
    "practitioner_id": "62e9a2123ccc0219a88d606f",
    "primary_insurance_company": "MGB",
    "primary_insurance_group_number": "121212",
    "primary_insurance_holder_date_of_birth": "1988-05-23T00:00:00Z",
    "primary_insurance_holder_name": "John Smith",
    "primary_insurance_holder_relationship": "Self",
    "primary_insurance_payer_id": "123456",
    "primary_insurance_plan": "MGB",
    "primary_insurance_policy_number": "654321",
    "primary_insured_city": "New York",
    "primary_insured_gender": "Male",
    "primary_insured_state": "NY",
    "primary_insured_street_address": "123 Main St",
    "primary_insured_zip_code": "10001",
    "primary_relationship_to_insured": "Self",
    "secondary_insurance_company": "MGB",
    "secondary_insurance_group_number": "121213",
    "secondary_insurance_holder_date_of_birth": "1988-05-23T00:00:00Z",
    "secondary_insurance_holder_name": "John Smith",
    "secondary_insurance_holder_relationship": "Self",
    "secondary_insurance_payer_id": "123457",
    "secondary_insurance_policy_number": "654322",
    "secondary_relationship_to_insured": "Self",
    "square_customer_id": "123456",
    "state": "NY",
    "state_short": "NY",
    "street_address": "123 Main St",
    "stripe_customer_id": "123456",
    "tags": [
      "website_lead"
    ],
    "timezone_id": "America/New_York",
    "unit_number": "1A",
    "work_phone": "(222) 222-2222"
  }
}
```

```json Result Object Description theme={null}
{
  "$result_object_key": {
    "additional_information": "Additional information about the client",
    "address": "Full address of the client",
    "archived": "Whether the client is archived",
    "billing_type": "Billing type for the client",
    "city": "City of the client's address",
    "client_id": "IntakeQ's unique identifier for the client",
    "country": "Country of the client's address",
    "created_at": "When the client was created",
    "credit_balance": "Client's credit balance",
    "custom_fields": {
      "field_id": "ID for the custom field",
      "text": "Text for the custom field",
      "value": "Value for the custom field"
    },
    "date_of_birth": "Date of birth of the client (note: This is not rounded to the nearest day by the IntakeQ API)",
    "email_address": "Email address of the client",
    "external_client_id": "External system client ID",
    "first_name": "First name of the client",
    "gender": "Gender of the client",
    "guid": "Globally unique identifier for the client",
    "home_phone": "Home phone number of the client",
    "last_activity_at": "When the client last had activity",
    "last_activity_name": "Name of the last activity",
    "last_name": "Last name of the client",
    "last_updated_at": "When the client was last updated",
    "linked_clients": {
      "client_number": "IntakeQ's unique identifier for the linked client",
      "relationship_type": "The relationship between the client and the linked client"
    },
    "marital_status": "Marital status of the client",
    "middle_name": "Middle name of the client",
    "mobile_phone": "Mobile phone number of the client",
    "name": "Full name of the client",
    "parent_client_id": "ID of the parent client if this is a child account",
    "phone_number": "Primary phone number of the client",
    "postal_code": "Postal/ZIP code of the client's address",
    "practitioner_id": "ID of the assigned practitioner",
    "primary_insurance_company": "Primary insurance company name",
    "primary_insurance_group_number": "Primary insurance group number",
    "primary_insurance_holder_date_of_birth": "Primary insurance holder date of birth",
    "primary_insurance_holder_name": "Primary insurance holder name",
    "primary_insurance_holder_relationship": "Primary insurance holder relationship to client",
    "primary_insurance_payer_id": "Primary insurance payer ID",
    "primary_insurance_plan": "Primary insurance plan name",
    "primary_insurance_policy_number": "Primary insurance policy number",
    "primary_insured_city": "Primary insured person's city",
    "primary_insured_gender": "Primary insured person's gender",
    "primary_insured_state": "Primary insured person's state",
    "primary_insured_street_address": "Primary insured person's street address",
    "primary_insured_zip_code": "Primary insured person's ZIP code",
    "primary_relationship_to_insured": "Primary insured person's relationship to the client",
    "secondary_insurance_company": "Secondary insurance company name",
    "secondary_insurance_group_number": "Secondary insurance group number",
    "secondary_insurance_holder_date_of_birth": "Secondary insurance holder date of birth",
    "secondary_insurance_holder_name": "Secondary insurance holder name",
    "secondary_insurance_holder_relationship": "Secondary insurance holder relationship to client",
    "secondary_insurance_payer_id": "Secondary insurance payer ID",
    "secondary_insurance_policy_number": "Secondary insurance policy number",
    "secondary_relationship_to_insured": "Secondary insurance relationship to insured",
    "square_customer_id": "Square customer ID",
    "state": "State/province of the client's address",
    "state_short": "State/province abbreviation of the client's address",
    "street_address": "Street address of the client",
    "stripe_customer_id": "Stripe customer ID",
    "tags": "Tags associated with the client",
    "timezone_id": "Timezone identifier for the client",
    "unit_number": "Unit/apartment number of the client's address",
    "work_phone": "Work phone number of the client"
  }
}
```

### Result Object Field Details

You can use the result of the action's data as inputs to downstream workflow actions.

Each fetch action requires an object name, which nests the action's result data inside the downstream data context in the workflow. See [Passing Data Between Actions](https://docs.morf.health/docs/knowledge_base/passing_data_between_actions.md) for how to set it and reference the result from downstream nodes.

Here we demonstrate how to refer to this data using the prefix `$result_object_key`.

**Client** `Fetch Action Response Object`

**fields**

**client\_id** `int64` *required*

IntakeQ's unique identifier for the client

```json CEL theme={null}
$result_object_key.client_id
```

```json Example theme={null}
42
```

**name** `string`

Full name of the client

```json CEL theme={null}
$result_object_key.name
```

```json Example theme={null}
"Ettore Bugatti"
```

**first\_name** `string`

First name of the client

```json CEL theme={null}
$result_object_key.first_name
```

```json Example theme={null}
"Ettore"
```

**last\_name** `string`

Last name of the client

```json CEL theme={null}
$result_object_key.last_name
```

```json Example theme={null}
"Bugatti"
```

**middle\_name** `string`

Middle name of the client

```json CEL theme={null}
$result_object_key.middle_name
```

```json Example theme={null}
""
```

**email\_address** `string`

Email address of the client

```json CEL theme={null}
$result_object_key.email_address
```

```json Example theme={null}
"ettore@bugatti.com"
```

**phone\_number** `string`

Primary phone number of the client

```json CEL theme={null}
$result_object_key.phone_number
```

```json Example theme={null}
"5554016515"
```

**date\_of\_birth** `timing.v1.Timestamp`

Date of birth of the client (note: This is not rounded to the nearest day by the IntakeQ API)

```json CEL theme={null}
$result_object_key.date_of_birth
```

```json Example theme={null}
"2016-03-21T04:48:00.368Z"
```

**marital\_status** `string`

Marital status of the client

```json CEL theme={null}
$result_object_key.marital_status
```

```json Example theme={null}
"Married"
```

**gender** `string`

Gender of the client

```json CEL theme={null}
$result_object_key.gender
```

```json Example theme={null}
"Female"
```

**tags** `[]string` *required*

Tags associated with the client

```json CEL theme={null}
$result_object_key.tags
```

```json Example theme={null}
[
"website_lead"
]
```

**archived** `bool` *required*

Whether the client is archived

```json CEL theme={null}
$result_object_key.archived
```

```json Example theme={null}
false
```

**home\_phone** `string`

Home phone number of the client

```json CEL theme={null}
$result_object_key.home_phone
```

```json Example theme={null}
"(222) 222-2222"
```

**work\_phone** `string`

Work phone number of the client

```json CEL theme={null}
$result_object_key.work_phone
```

```json Example theme={null}
"(222) 222-2222"
```

**mobile\_phone** `string`

Mobile phone number of the client

```json CEL theme={null}
$result_object_key.mobile_phone
```

```json Example theme={null}
"(222) 222-2222"
```

**address** `string`

Full address of the client

```json CEL theme={null}
$result_object_key.address
```

```json Example theme={null}
"123 Main St, Anytown, USA 12345"
```

**unit\_number** `string`

Unit/apartment number of the client's address

```json CEL theme={null}
$result_object_key.unit_number
```

```json Example theme={null}
"1A"
```

**street\_address** `string`

Street address of the client

```json CEL theme={null}
$result_object_key.street_address
```

```json Example theme={null}
"123 Main St"
```

**city** `string`

City of the client's address

```json CEL theme={null}
$result_object_key.city
```

```json Example theme={null}
"Anytown"
```

**state** `string`

State/province of the client's address

```json CEL theme={null}
$result_object_key.state
```

```json Example theme={null}
"NY"
```

**postal\_code** `string`

Postal/ZIP code of the client's address

```json CEL theme={null}
$result_object_key.postal_code
```

```json Example theme={null}
"12345"
```

**country** `string`

Country of the client's address

```json CEL theme={null}
$result_object_key.country
```

```json Example theme={null}
"USA"
```

**state\_short** `string`

State/province abbreviation of the client's address

```json CEL theme={null}
$result_object_key.state_short
```

```json Example theme={null}
"NY"
```

**additional\_information** `string`

Additional information about the client

```json CEL theme={null}
$result_object_key.additional_information
```

```json Example theme={null}
"test"
```

**billing\_type** `intakeq.v1.BillingType` *required*

Billing type for the client

```json CEL theme={null}
$result_object_key.billing_type
```

```json Example theme={null}
intakeq.v1.BillingType.SELF_PAY
intakeq.v1.BillingType.INSURANCE
```

**primary\_insurance\_company** `string`

Primary insurance company name

```json CEL theme={null}
$result_object_key.primary_insurance_company
```

```json Example theme={null}
"MGB"
```

**primary\_insurance\_payer\_id** `string`

Primary insurance payer ID

```json CEL theme={null}
$result_object_key.primary_insurance_payer_id
```

```json Example theme={null}
"123456"
```

**primary\_insurance\_policy\_number** `string`

Primary insurance policy number

```json CEL theme={null}
$result_object_key.primary_insurance_policy_number
```

```json Example theme={null}
"654321"
```

**primary\_insurance\_group\_number** `string`

Primary insurance group number

```json CEL theme={null}
$result_object_key.primary_insurance_group_number
```

```json Example theme={null}
"121212"
```

**primary\_insurance\_holder\_name** `string`

Primary insurance holder name

```json CEL theme={null}
$result_object_key.primary_insurance_holder_name
```

```json Example theme={null}
"John Smith"
```

**primary\_insurance\_holder\_relationship** `string`

Primary insurance holder relationship to client

```json CEL theme={null}
$result_object_key.primary_insurance_holder_relationship
```

```json Example theme={null}
"Self"
```

**primary\_insurance\_holder\_date\_of\_birth** `timing.v1.Timestamp`

Primary insurance holder date of birth

```json CEL theme={null}
$result_object_key.primary_insurance_holder_date_of_birth
```

```json Example theme={null}
"1988-05-23T00:00:00Z"
```

**secondary\_insurance\_company** `string`

Secondary insurance company name

```json CEL theme={null}
$result_object_key.secondary_insurance_company
```

```json Example theme={null}
"MGB"
```

**secondary\_insurance\_payer\_id** `string`

Secondary insurance payer ID

```json CEL theme={null}
$result_object_key.secondary_insurance_payer_id
```

```json Example theme={null}
"123457"
```

**secondary\_insurance\_policy\_number** `string`

Secondary insurance policy number

```json CEL theme={null}
$result_object_key.secondary_insurance_policy_number
```

```json Example theme={null}
"654322"
```

**secondary\_insurance\_group\_number** `string`

Secondary insurance group number

```json CEL theme={null}
$result_object_key.secondary_insurance_group_number
```

```json Example theme={null}
"121213"
```

**secondary\_insurance\_holder\_name** `string`

Secondary insurance holder name

```json CEL theme={null}
$result_object_key.secondary_insurance_holder_name
```

```json Example theme={null}
"John Smith"
```

**secondary\_insurance\_holder\_relationship** `string`

Secondary insurance holder relationship to client

```json CEL theme={null}
$result_object_key.secondary_insurance_holder_relationship
```

```json Example theme={null}
"Self"
```

**secondary\_insurance\_holder\_date\_of\_birth** `timing.v1.Timestamp`

Secondary insurance holder date of birth

```json CEL theme={null}
$result_object_key.secondary_insurance_holder_date_of_birth
```

```json Example theme={null}
"1988-05-23T00:00:00Z"
```

**secondary\_relationship\_to\_insured** `string`

Secondary insurance relationship to insured

```json CEL theme={null}
$result_object_key.secondary_relationship_to_insured
```

```json Example theme={null}
"Self"
```

**created\_at** `timing.v1.Timestamp` *required*

When the client was created

```json CEL theme={null}
$result_object_key.created_at
```

```json Example theme={null}
"2024-02-25T23:24:31.585Z"
```

**last\_activity\_at** `timing.v1.Timestamp`

When the client last had activity

```json CEL theme={null}
$result_object_key.last_activity_at
```

```json Example theme={null}
"2024-02-25T23:24:31.585Z"
```

**practitioner\_id** `string`

ID of the assigned practitioner

```json CEL theme={null}
$result_object_key.practitioner_id
```

```json Example theme={null}
"62e9a2123ccc0219a88d606f"
```

**custom\_fields** `[]object` *required*

Custom fields associated with the client

```json CEL theme={null}
$result_object_key.custom_fields
```

```json Example theme={null}
[
{
"field_id": "rjrx",
"text": "Intake Concern",
"value": "AB1"
}
]
```

**custom\_fields.map(x, x.field\_id)** `[]string` *required*

Mapped array of: ID for the custom field

```json CEL theme={null}
$result_object_key.custom_fields.map(x, x.field_id)
```

```json Example theme={null}
[
"rjrx"
]
```

**custom\_fields.map(x, x.text)** `[]string` *required*

Mapped array of: Text for the custom field

```json CEL theme={null}
$result_object_key.custom_fields.map(x, x.text)
```

```json Example theme={null}
[
"Intake Concern"
]
```

**custom\_fields.map(x, x.value)** `[]string` *required*

Mapped array of: Value for the custom field

```json CEL theme={null}
$result_object_key.custom_fields.map(x, x.value)
```

```json Example theme={null}
[
"AB1"
]
```

**guid** `string`

Globally unique identifier for the client

```json CEL theme={null}
$result_object_key.guid
```

```json Example theme={null}
"dd67fe12-2eea-4776-b5b0-91248102da43"
```

**last\_updated\_at** `timing.v1.Timestamp`

When the client was last updated

```json CEL theme={null}
$result_object_key.last_updated_at
```

```json Example theme={null}
"2024-02-25T23:25:01.675Z"
```

**stripe\_customer\_id** `string`

Stripe customer ID

```json CEL theme={null}
$result_object_key.stripe_customer_id
```

```json Example theme={null}
"123456"
```

**square\_customer\_id** `string`

Square customer ID

```json CEL theme={null}
$result_object_key.square_customer_id
```

```json Example theme={null}
"123456"
```

**timezone\_id** `string`

Timezone identifier for the client

```json CEL theme={null}
$result_object_key.timezone_id
```

```json Example theme={null}
"America/New_York"
```

**primary\_insurance\_plan** `string`

Primary insurance plan name

```json CEL theme={null}
$result_object_key.primary_insurance_plan
```

```json Example theme={null}
"MGB"
```

**primary\_insured\_gender** `string`

Primary insured person's gender

```json CEL theme={null}
$result_object_key.primary_insured_gender
```

```json Example theme={null}
"Male"
```

**primary\_insured\_city** `string`

Primary insured person's city

```json CEL theme={null}
$result_object_key.primary_insured_city
```

```json Example theme={null}
"New York"
```

**primary\_insured\_zip\_code** `string`

Primary insured person's ZIP code

```json CEL theme={null}
$result_object_key.primary_insured_zip_code
```

```json Example theme={null}
"10001"
```

**primary\_insured\_state** `string`

Primary insured person's state

```json CEL theme={null}
$result_object_key.primary_insured_state
```

```json Example theme={null}
"NY"
```

**primary\_insured\_street\_address** `string`

Primary insured person's street address

```json CEL theme={null}
$result_object_key.primary_insured_street_address
```

```json Example theme={null}
"123 Main St"
```

**external\_client\_id** `string`

External system client ID

```json CEL theme={null}
$result_object_key.external_client_id
```

```json Example theme={null}
"a7699305-7142-4599-a661-717b6bcd3305"
```

**credit\_balance** `float64 (double)` *required*

Client's credit balance

```json CEL theme={null}
$result_object_key.credit_balance
```

```json Example theme={null}
0
```

**last\_activity\_name** `string`

Name of the last activity

```json CEL theme={null}
$result_object_key.last_activity_name
```

```json Example theme={null}
"Created Appt"
```

**parent\_client\_id** `string`

ID of the parent client if this is a child account

```json CEL theme={null}
$result_object_key.parent_client_id
```

```json Example theme={null}
"412421"
```

**linked\_clients** `[]object` *required*

List of clients linked to this client

```json CEL theme={null}
$result_object_key.linked_clients
```

```json Example theme={null}
[
{
"client_number": 42,
"relationship_type": null
}
]
```

**linked\_clients.map(x, x.client\_number)** `[]int64` *required*

Mapped array of: IntakeQ's unique identifier for the linked client

```json CEL theme={null}
$result_object_key.linked_clients.map(x, x.client_number)
```

```json Example theme={null}
[
42
]
```

**relationship\_type** `intakeq.v1.RelationshipType` *required*

Mapped array of: The relationship between the client and the linked client

```json CEL theme={null}
relationship_type
```

```json Example theme={null}
intakeq.v1.RelationshipType.PARENT
intakeq.v1.RelationshipType.CHILD
intakeq.v1.RelationshipType.SPOUSE
intakeq.v1.RelationshipType.SIBLING
intakeq.v1.RelationshipType.OTHER
intakeq.v1.RelationshipType.PARTNER
```

**primary\_relationship\_to\_insured** `string`

Primary insured person's relationship to the client

```json CEL theme={null}
$result_object_key.primary_relationship_to_insured
```

```json Example theme={null}
"Self"
```


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