Get Person

Get a specific person

curl --request GET \
  --url https://api.wellapp.ai/v1/people/{id} \
  --header 'Authorization: <authorization>'

{
  "data": {
    "type": "people",
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "attributes": {
      "first_name": "John",
      "last_name": "Doe",
      "full_name": "John Doe",
      "created_at": "2024-01-15T10:30:00Z",
      "updated_at": "2024-01-20T14:45:00Z"
    },
    "relationships": {
      "emails": {
        "data": [
          {
            "type": "<string>",
            "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
          }
        ]
      },
      "phones": {
        "data": [
          {
            "type": "<string>",
            "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
          }
        ]
      },
      "web_links": {
        "data": [
          {
            "type": "<string>",
            "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
          }
        ]
      },
      "companies": {
        "data": [
          {
            "type": "<string>",
            "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "meta": {
              "relationship_type": "employee"
            }
          }
        ]
      },
      "medias": {
        "data": [
          {
            "type": "<string>",
            "id": "550e8400-e29b-41d4-a716-446655440002"
          }
        ]
      },
      "workspaces": {
        "data": [
          {
            "type": "<string>",
            "id": "632860b5-48b7-49eb-9dd1-8bddc634f387"
          }
        ]
      },
      "memberships": {
        "data": [
          {
            "type": "<string>",
            "id": "632860b5-48b7-49eb-9dd1-8bddc634f387"
          }
        ]
      },
      "documents": {
        "data": [
          {
            "type": "<string>",
            "id": "550e8400-e29b-41d4-a716-446655440009"
          }
        ]
      }
    },
    "included": {
      "emails": [
        {
          "type": "<string>",
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "attributes": {
            "value": "[email protected]",
            "is_primary": true,
            "label": "work",
            "created_at": "2023-06-15T10:30:00Z",
            "updated_at": "2023-06-15T10:30:00Z"
          }
        }
      ],
      "phones": [
        {
          "type": "<string>",
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "attributes": {
            "number": "+14155552671",
            "label": "work",
            "is_primary": true,
            "created_at": "2023-11-07T05:31:56Z"
          }
        }
      ],
      "web_links": [
        {
          "type": "<string>",
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "attributes": {
            "platform": "website",
            "url": "<string>",
            "created_at": "2023-11-07T05:31:56Z",
            "updated_at": "2023-11-07T05:31:56Z"
          }
        }
      ],
      "companies": [
        {
          "type": "<string>",
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "attributes": {
            "description": "<string>",
            "domain_name_primary_link_url": "<string>",
            "tax_id": {
              "value": "<string>",
              "type": "<string>"
            },
            "registration": {
              "trade_name": "<string>",
              "registered_name": "<string>"
            },
            "registration_number": {
              "business_type": "<string>",
              "value": "<string>",
              "registry_name": "<string>",
              "registry_country": "<string>"
            },
            "workspace_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "created_at": "2023-11-07T05:31:56Z",
            "updated_at": "2023-11-07T05:31:56Z"
          }
        }
      ],
      "workspaces": {
        "data": [
          {
            "type": "<string>",
            "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "attributes": {
              "name": "<string>",
              "description": "<string>",
              "avatar_color": "<string>",
              "external_workspace_id": "<string>"
            }
          }
        ]
      },
      "medias": {
        "data": [
          {
            "type": "<string>",
            "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "attributes": {
              "media_type": "avatar",
              "url": "<string>",
              "is_primary": true,
              "processed_at": "2023-11-07T05:31:56Z",
              "uploaded_at": "2023-11-07T05:31:56Z"
            }
          }
        ]
      },
      "memberships": {
        "data": [
          {
            "type": "<string>",
            "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "attributes": {
              "role": "<string>",
              "firebase_id": "<string>",
              "created_at": "2023-11-07T05:31:56Z",
              "updated_at": "2023-11-07T05:31:56Z"
            }
          }
        ]
      },
      "documents": {
        "data": [
          {
            "type": "<string>",
            "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "attributes": {
              "file_name": "<string>",
              "status": "<string>",
              "uploaded_at": "2023-11-07T05:31:56Z",
              "processed_at": "2023-11-07T05:31:56Z",
              "file_type": "<string>",
              "size_bytes": 123
            }
          }
        ]
      }
    }
  }
}

GET

people

{id}

Get a specific person

curl --request GET \
  --url https://api.wellapp.ai/v1/people/{id} \
  --header 'Authorization: <authorization>'

{
  "data": {
    "type": "people",
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "attributes": {
      "first_name": "John",
      "last_name": "Doe",
      "full_name": "John Doe",
      "created_at": "2024-01-15T10:30:00Z",
      "updated_at": "2024-01-20T14:45:00Z"
    },
    "relationships": {
      "emails": {
        "data": [
          {
            "type": "<string>",
            "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
          }
        ]
      },
      "phones": {
        "data": [
          {
            "type": "<string>",
            "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
          }
        ]
      },
      "web_links": {
        "data": [
          {
            "type": "<string>",
            "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
          }
        ]
      },
      "companies": {
        "data": [
          {
            "type": "<string>",
            "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "meta": {
              "relationship_type": "employee"
            }
          }
        ]
      },
      "medias": {
        "data": [
          {
            "type": "<string>",
            "id": "550e8400-e29b-41d4-a716-446655440002"
          }
        ]
      },
      "workspaces": {
        "data": [
          {
            "type": "<string>",
            "id": "632860b5-48b7-49eb-9dd1-8bddc634f387"
          }
        ]
      },
      "memberships": {
        "data": [
          {
            "type": "<string>",
            "id": "632860b5-48b7-49eb-9dd1-8bddc634f387"
          }
        ]
      },
      "documents": {
        "data": [
          {
            "type": "<string>",
            "id": "550e8400-e29b-41d4-a716-446655440009"
          }
        ]
      }
    },
    "included": {
      "emails": [
        {
          "type": "<string>",
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "attributes": {
            "value": "[email protected]",
            "is_primary": true,
            "label": "work",
            "created_at": "2023-06-15T10:30:00Z",
            "updated_at": "2023-06-15T10:30:00Z"
          }
        }
      ],
      "phones": [
        {
          "type": "<string>",
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "attributes": {
            "number": "+14155552671",
            "label": "work",
            "is_primary": true,
            "created_at": "2023-11-07T05:31:56Z"
          }
        }
      ],
      "web_links": [
        {
          "type": "<string>",
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "attributes": {
            "platform": "website",
            "url": "<string>",
            "created_at": "2023-11-07T05:31:56Z",
            "updated_at": "2023-11-07T05:31:56Z"
          }
        }
      ],
      "companies": [
        {
          "type": "<string>",
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "attributes": {
            "description": "<string>",
            "domain_name_primary_link_url": "<string>",
            "tax_id": {
              "value": "<string>",
              "type": "<string>"
            },
            "registration": {
              "trade_name": "<string>",
              "registered_name": "<string>"
            },
            "registration_number": {
              "business_type": "<string>",
              "value": "<string>",
              "registry_name": "<string>",
              "registry_country": "<string>"
            },
            "workspace_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "created_at": "2023-11-07T05:31:56Z",
            "updated_at": "2023-11-07T05:31:56Z"
          }
        }
      ],
      "workspaces": {
        "data": [
          {
            "type": "<string>",
            "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "attributes": {
              "name": "<string>",
              "description": "<string>",
              "avatar_color": "<string>",
              "external_workspace_id": "<string>"
            }
          }
        ]
      },
      "medias": {
        "data": [
          {
            "type": "<string>",
            "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "attributes": {
              "media_type": "avatar",
              "url": "<string>",
              "is_primary": true,
              "processed_at": "2023-11-07T05:31:56Z",
              "uploaded_at": "2023-11-07T05:31:56Z"
            }
          }
        ]
      },
      "memberships": {
        "data": [
          {
            "type": "<string>",
            "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "attributes": {
              "role": "<string>",
              "firebase_id": "<string>",
              "created_at": "2023-11-07T05:31:56Z",
              "updated_at": "2023-11-07T05:31:56Z"
            }
          }
        ]
      },
      "documents": {
        "data": [
          {
            "type": "<string>",
            "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "attributes": {
              "file_name": "<string>",
              "status": "<string>",
              "uploaded_at": "2023-11-07T05:31:56Z",
              "processed_at": "2023-11-07T05:31:56Z",
              "file_type": "<string>",
              "size_bytes": 123
            }
          }
        ]
      }
    }
  }
}

Headers

Authorization

string

required

Bearer token for authentication

Path Parameters

string<uuid>

required

UUID of the person to retrieve

Response

Person retrieved successfully

data

object

Show child attributes

data.type

string

Example:

"people"

data.id

string<uuid>

data.attributes

object

Show child attributes

data.attributes.first_name

string

Person's first name

Example:

"John"

data.attributes.last_name

string

Person's last name

Example:

"Doe"

data.attributes.full_name

string

Person's full name (first + last)

Example:

"John Doe"

data.attributes.created_at

string<date-time>

Timestamp when the person was created

Example:

"2024-01-15T10:30:00Z"

data.attributes.updated_at

string<date-time>

Timestamp when the person was last updated

Example:

"2024-01-20T14:45:00Z"

data.relationships

object

Show child attributes

data.relationships.emails

object

Show child attributes

data.relationships.emails.data

object[]

Show child attributes

data.relationships.emails.data.type

string

Allowed value: "email"

data.relationships.emails.data.id

string<uuid>

data.relationships.phones

object

Show child attributes

data.relationships.phones.data

object[]

Show child attributes

data.relationships.phones.data.type

string

Allowed value: "phone"

data.relationships.phones.data.id

string<uuid>

data.relationships.web_links

object

Show child attributes

data.relationships.web_links.data

object[]

Show child attributes

data.relationships.web_links.data.type

string

Allowed value: "web_link"

data.relationships.web_links.data.id

string<uuid>

data.relationships.companies

object

Show child attributes

data.relationships.companies.data

object[]

Show child attributes

data.relationships.companies.data.type

string

required

Allowed value: "company"

data.relationships.companies.data.id

string<uuid>

required

data.relationships.companies.data.meta

object

required

Show child attributes

data.relationships.companies.data.meta.relationship_type

enum<string>

required

Relationship type of the person in the company

Available options:

contact,

employee,

owner,

other

Example:

"employee"

data.relationships.medias

object

Show child attributes

data.relationships.medias.data

object[]

Show child attributes

data.relationships.medias.data.type

string

Allowed value: "media"

data.relationships.medias.data.id

string<uuid>

UUID of the media file

Example:

"550e8400-e29b-41d4-a716-446655440002"

data.relationships.workspaces

object

Show child attributes

data.relationships.workspaces.data

object[]

Show child attributes

data.relationships.workspaces.data.type

string

Allowed value: "workspace"

data.relationships.workspaces.data.id

string<uuid>

UUID of the workspace

Example:

"632860b5-48b7-49eb-9dd1-8bddc634f387"

data.relationships.memberships

object

Show child attributes

data.relationships.memberships.data

object[]

Show child attributes

data.relationships.memberships.data.type

string

Allowed value: "memberships"

data.relationships.memberships.data.id

string<uuid>

UUID of the memberships

Example:

"632860b5-48b7-49eb-9dd1-8bddc634f387"

data.relationships.documents

object

Show child attributes

data.relationships.documents.data

object[]

Show child attributes

data.relationships.documents.data.type

string

Allowed value: "document"

data.relationships.documents.data.id

string<uuid>

UUID of the document

Example:

"550e8400-e29b-41d4-a716-446655440009"

data.included

object

Included resources grouped by type

Show child attributes

data.included.emails

object[]

Show child attributes

data.included.emails.type

string

Type of the included email resource

Allowed value: "email"

data.included.emails.id

string<uuid>

UUID of the email

data.included.emails.attributes

object

Show child attributes

data.included.emails.attributes.value

string<email>

Email address value

Example:

"[email protected]"

data.included.emails.attributes.is_primary

boolean

default:true

Whether this is the primary email address. Defaults to 'false', unless no other email is marked as primary (in which case it becomes 'true'). Only one email can be marked as primary per person/company.

Example:

true

data.included.emails.attributes.label

enum<string>

default:work

Email label type. See all available labels for complete list.

Available options:

work,

personal,

other,

...

Example:

"work"

data.included.emails.attributes.created_at

string<date-time>

Timestamp when the email was created

Example:

"2023-06-15T10:30:00Z"

data.included.emails.attributes.updated_at

string<date-time>

Timestamp when the email was last updated

Example:

"2023-06-15T10:30:00Z"

data.included.phones

object[]

Show child attributes

data.included.phones.type

string

Type of the included phone resource

Allowed value: "phone"

data.included.phones.id

string<uuid>

UUID of the phone

data.included.phones.attributes

object

Show child attributes

data.included.phones.attributes.number

string

Full international phone number in E164 format

Example:

"+14155552671"

data.included.phones.attributes.label

enum<string>

Phone label type. See all available labels for complete list.

Available options:

work,

personal,

other,

...

data.included.phones.attributes.is_primary

boolean

Whether this is the primary phone number

data.included.phones.attributes.created_at

string<date-time>

Timestamp when the phone was created

data.included.web_links

object[]

Show child attributes

data.included.web_links.type

string

Type of the included social link resource

Allowed value: "social_links"

data.included.web_links.id

string<uuid>

UUID of the social link

data.included.web_links.attributes

object

Show child attributes

data.included.web_links.attributes.platform

enum<string>

Web platform type

Available options:

website,

linkedin,

x,

github

data.included.web_links.attributes.url

string

Full profile URL

data.included.web_links.attributes.created_at

string<date-time>

Date and time when the web link was created

data.included.web_links.attributes.updated_at

string<date-time>

Date and time when the web link was updated

data.included.companies

object[]

Show child attributes

data.included.companies.type

string

Type of the included company resource

Allowed value: "company"

data.included.companies.id

string<uuid>

UUID of the company

data.included.companies.attributes

object

Show child attributes

data.included.companies.attributes.description

string

data.included.companies.attributes.domain_name_primary_link_url

string<url>

The domain url from the website or email address of the company. Used as unique identifier in some cases.

Maximum string length: 500

data.included.companies.attributes.tax_id

object

Show child attributes

data.included.companies.attributes.tax_id.value

string

Tax ID issued by local or national tax authority.

data.included.companies.attributes.tax_id.type

string

Type of tax ID, useful for applying formatting and validation rules.

data.included.companies.attributes.registration

object

Show child attributes

data.included.companies.attributes.registration.trade_name

string

Commercial or branding name (if different from registered name).

data.included.companies.attributes.registration.registered_name

string

Legal company name.

Required string length: 1 - 100

data.included.companies.attributes.registration_number

object

Show child attributes

data.included.companies.attributes.registration_number.business_type

string

Legal entity structure type.

data.included.companies.attributes.registration_number.value

string

Official company registration number.

data.included.companies.attributes.registration_number.registry_name

string

Name of the official registration body.

data.included.companies.attributes.registration_number.registry_country

string

Country of the registry authority. (string (ISO 3166-1 alpha-2))

data.included.companies.attributes.workspace_id

string<uuid>

UUID of the workspace associated with this company

data.included.companies.attributes.created_at

string<date-time>

data.included.companies.attributes.updated_at

string<date-time>

data.included.workspaces

object

Workspaces associated with this company

Show child attributes

data.included.workspaces.data

object[]

Show child attributes

data.included.workspaces.data.type

string

Allowed value: "workspace"

data.included.workspaces.data.id

string<uuid>

UUID of the workspace

data.included.workspaces.data.attributes

object

Show child attributes

data.included.workspaces.data.attributes.name

string

required

Workspace name

Required string length: 1 - 255

data.included.workspaces.data.attributes.description

string

Workspace description

Maximum string length: 1000

data.included.workspaces.data.attributes.avatar_color

string

Avatar color in hexadecimal format (e.g., #FF5733)

data.included.workspaces.data.attributes.external_workspace_id

string

External workspace identifier

Required string length: 1 - 255

data.included.medias

object

Media files associated with this person

Show child attributes

data.included.medias.data

object[]

Show child attributes

data.included.medias.data.type

string

Allowed value: "media"

data.included.medias.data.id

string<uuid>

UUID of the media

data.included.medias.data.attributes

object

Show child attributes

data.included.medias.data.attributes.media_type

enum<string>

Available options:

avatar,

logo,

banner

data.included.medias.data.attributes.url

string<uri>

URL to the media file

data.included.medias.data.attributes.is_primary

boolean

Whether this is the primary media

data.included.medias.data.attributes.processed_at

string<date-time>

Timestamp when media processing completed

data.included.medias.data.attributes.uploaded_at

string<date-time>

data.included.memberships

object

membership to a workspace

Show child attributes

data.included.memberships.data

object[]

Show child attributes

data.included.memberships.data.type

string

Allowed value: "media"

data.included.memberships.data.id

string<uuid>

UUID of the media

data.included.memberships.data.attributes

object

Show child attributes

data.included.memberships.data.attributes.role

string

data.included.memberships.data.attributes.firebase_id

string

data.included.memberships.data.attributes.created_at

string<date-time>

data.included.memberships.data.attributes.updated_at

string<date-time>

data.included.documents

object

Documents associated with this company

Show child attributes

data.included.documents.data

object[]

Show child attributes

data.included.documents.data.type

string

Allowed value: "document"

data.included.documents.data.id

string<uuid>

UUID of the document

data.included.documents.data.attributes

object

Show child attributes

data.included.documents.data.attributes.file_name

string

data.included.documents.data.attributes.status

string

data.included.documents.data.attributes.uploaded_at

string<date-time>

data.included.documents.data.attributes.processed_at

string<date-time>

data.included.documents.data.attributes.file_type

string

data.included.documents.data.attributes.size_bytes

integer

Create Person Delete Person

⌘I

Main Resources

Atomic Resources

System

Headers

Path Parameters

Response