Create Person

Create a new person

curl --request POST \
  --url https://api.wellapp.ai/v1/people \
  --header 'Authorization: <authorization>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "type": "<string>",
  "attributes": {
    "first_name": "Marie",
    "last_name": "Dubois"
  },
  "relationships": {
    "emails": {
      "data": [
        {
          "type": "<string>",
          "id": "<string>"
        }
      ]
    },
    "phones": {
      "data": [
        {
          "type": "<string>",
          "id": "<string>"
        }
      ]
    },
    "web_links": {
      "data": [
        {
          "type": "<string>",
          "id": "<string>"
        }
      ]
    },
    "companies": {
      "data": [
        {
          "type": "<string>",
          "id": "<string>"
        }
      ]
    },
    "workspaces": {
      "data": [
        {
          "type": "<string>",
          "id": "<string>"
        }
      ]
    },
    "documents": {
      "data": [
        {
          "type": "<string>",
          "id": "<string>"
        }
      ]
    },
    "memberships": {
      "data": [
        {
          "type": "<string>",
          "id": "<string>"
        }
      ]
    },
    "medias": {
      "data": [
        {
          "type": "<string>",
          "id": "<string>"
        }
      ]
    }
  },
  "included": {
    "emails": {
      "data": [
        {
          "type": "<string>",
          "id": "<string>",
          "attributes": {
            "value": "[email protected]",
            "is_primary": true,
            "label": "work",
            "created_at": "2023-06-15T10:30:00Z",
            "updated_at": "2023-06-15T10:30:00Z"
          }
        }
      ]
    },
    "phones": {
      "data": [
        {
          "type": "<string>",
          "id": "<string>",
          "attributes": {
            "number": "+14155552671",
            "is_primary": true,
            "label": "work"
          }
        }
      ]
    },
    "web_links": {
      "data": [
        {
          "type": "<string>",
          "id": "<string>",
          "attributes": {
            "url": "<string>",
            "platform": "website"
          }
        }
      ]
    },
    "companies": {
      "data": [
        {
          "type": "<string>",
          "id": "<string>",
          "attributes": {
            "registration": {
              "registered_name": "TechCorp AI Solutions LLC",
              "trade_name": "TechSol"
            },
            "locale": "en-US",
            "domain_name_primary_link_url": "https://www.techcorp.com",
            "tax_id": {
              "value": "DE123456789",
              "type": [
                "VAT",
                "TVA",
                "IVA",
                "..."
              ]
            },
            "registration_number": {
              "business_type": "GmbH",
              "value": "HRB 123456",
              "registry_name": "Handelsregister Berlin",
              "registry_country": "DE, FR, US, etc."
            },
            "description": "An innovative technology company focused on AI solutions"
          }
        }
      ]
    },
    "workspaces": {
      "data": [
        {
          "type": "<string>",
          "id": "<string>",
          "attributes": {
            "name": "<string>",
            "description": "<string>",
            "avatar_color": "<string>",
            "external_workspace_id": "<string>"
          }
        }
      ]
    },
    "documents": {
      "data": [
        {
          "type": "<string>",
          "id": "<string>",
          "attributes": {
            "file_name": "<string>",
            "status": "<string>",
            "file_type": "<string>",
            "size_bytes": 123
          }
        }
      ]
    },
    "memberships": {
      "data": [
        {
          "type": "<string>",
          "id": "<string>",
          "attributes": {
            "role": "admin",
            "firebase_id": "<string>"
          }
        }
      ]
    },
    "medias": {
      "data": [
        {
          "type": "<string>",
          "id": "<string>",
          "attributes": {
            "media_type": "avatar",
            "is_primary": true
          }
        }
      ]
    }
  }
}
'

{
  "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
            }
          }
        ]
      }
    }
  }
}

POST

people

Create a new person

curl --request POST \
  --url https://api.wellapp.ai/v1/people \
  --header 'Authorization: <authorization>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "type": "<string>",
  "attributes": {
    "first_name": "Marie",
    "last_name": "Dubois"
  },
  "relationships": {
    "emails": {
      "data": [
        {
          "type": "<string>",
          "id": "<string>"
        }
      ]
    },
    "phones": {
      "data": [
        {
          "type": "<string>",
          "id": "<string>"
        }
      ]
    },
    "web_links": {
      "data": [
        {
          "type": "<string>",
          "id": "<string>"
        }
      ]
    },
    "companies": {
      "data": [
        {
          "type": "<string>",
          "id": "<string>"
        }
      ]
    },
    "workspaces": {
      "data": [
        {
          "type": "<string>",
          "id": "<string>"
        }
      ]
    },
    "documents": {
      "data": [
        {
          "type": "<string>",
          "id": "<string>"
        }
      ]
    },
    "memberships": {
      "data": [
        {
          "type": "<string>",
          "id": "<string>"
        }
      ]
    },
    "medias": {
      "data": [
        {
          "type": "<string>",
          "id": "<string>"
        }
      ]
    }
  },
  "included": {
    "emails": {
      "data": [
        {
          "type": "<string>",
          "id": "<string>",
          "attributes": {
            "value": "[email protected]",
            "is_primary": true,
            "label": "work",
            "created_at": "2023-06-15T10:30:00Z",
            "updated_at": "2023-06-15T10:30:00Z"
          }
        }
      ]
    },
    "phones": {
      "data": [
        {
          "type": "<string>",
          "id": "<string>",
          "attributes": {
            "number": "+14155552671",
            "is_primary": true,
            "label": "work"
          }
        }
      ]
    },
    "web_links": {
      "data": [
        {
          "type": "<string>",
          "id": "<string>",
          "attributes": {
            "url": "<string>",
            "platform": "website"
          }
        }
      ]
    },
    "companies": {
      "data": [
        {
          "type": "<string>",
          "id": "<string>",
          "attributes": {
            "registration": {
              "registered_name": "TechCorp AI Solutions LLC",
              "trade_name": "TechSol"
            },
            "locale": "en-US",
            "domain_name_primary_link_url": "https://www.techcorp.com",
            "tax_id": {
              "value": "DE123456789",
              "type": [
                "VAT",
                "TVA",
                "IVA",
                "..."
              ]
            },
            "registration_number": {
              "business_type": "GmbH",
              "value": "HRB 123456",
              "registry_name": "Handelsregister Berlin",
              "registry_country": "DE, FR, US, etc."
            },
            "description": "An innovative technology company focused on AI solutions"
          }
        }
      ]
    },
    "workspaces": {
      "data": [
        {
          "type": "<string>",
          "id": "<string>",
          "attributes": {
            "name": "<string>",
            "description": "<string>",
            "avatar_color": "<string>",
            "external_workspace_id": "<string>"
          }
        }
      ]
    },
    "documents": {
      "data": [
        {
          "type": "<string>",
          "id": "<string>",
          "attributes": {
            "file_name": "<string>",
            "status": "<string>",
            "file_type": "<string>",
            "size_bytes": 123
          }
        }
      ]
    },
    "memberships": {
      "data": [
        {
          "type": "<string>",
          "id": "<string>",
          "attributes": {
            "role": "admin",
            "firebase_id": "<string>"
          }
        }
      ]
    },
    "medias": {
      "data": [
        {
          "type": "<string>",
          "id": "<string>",
          "attributes": {
            "media_type": "avatar",
            "is_primary": true
          }
        }
      ]
    }
  }
}
'

{
  "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

Body

application/json

Central entity representing individuals with comprehensive contact information

string<uuid>

required

Unique person identifier (UUID v4)

Example:

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

type

string

required

JSON:API resource type identifier

Allowed value: "people"

attributes

object

required

Person attribute data

Show child attributes

attributes.first_name

string

required

Person's first name

Required string length: 1 - 100

Example:

"Marie"

attributes.last_name

string

required

Person's last name

Required string length: 1 - 100

Example:

"Dubois"

relationships

object

Person relationship references

Show child attributes

relationships.emails

object

Email addresses associated with this person

Show child attributes

relationships.emails.data

object[]

Show child attributes

relationships.emails.data.type

string

required

Allowed value: "email"

relationships.emails.data.id

string

required

UUID of an existing email or temp-id that references an email defined in the included array

relationships.phones

object

Phone numbers associated with this person

Show child attributes

relationships.phones.data

object[]

Show child attributes

relationships.phones.data.type

string

required

Allowed value: "phone"

relationships.phones.data.id

string

required

UUID of an existing phone or temp-id that references a phone defined in the included array

relationships.web_links

object

Social media profiles associated with this person

Show child attributes

relationships.web_links.data

object[]

Show child attributes

relationships.web_links.data.type

string

required

Allowed value: "social_link"

relationships.web_links.data.id

string

required

UUID of an existing web link or temp-id that references a web link defined in the included array

relationships.companies

object

Companies associated with this person

Show child attributes

relationships.companies.data

object[]

Show child attributes

relationships.companies.data.type

string

required

Allowed value: "company"

relationships.companies.data.id

string

required

UUID of an existing company or temp-id that references a company defined in the included array

relationships.workspaces

object

Workspaces this person belongs to

Show child attributes

relationships.workspaces.data

object[]

Show child attributes

relationships.workspaces.data.type

string

required

Allowed value: "workspace"

relationships.workspaces.data.id

string

required

UUID of an existing workspace or temp-id that references a workspace defined in the included array

relationships.documents

object

Documents associated with this person

Show child attributes

relationships.documents.data

object[]

Show child attributes

relationships.documents.data.type

string

required

Allowed value: "document"

relationships.documents.data.id

string

required

UUID of an existing document or temp-id that references a document defined in the included array

relationships.memberships

object

Workspace memberships with roles and permissions

Show child attributes

relationships.memberships.data

object[]

Show child attributes

relationships.memberships.data.type

string

required

Allowed value: "membership"

relationships.memberships.data.id

string

required

UUID of an existing membership or temp-id that references a membership defined in the included array

relationships.medias

object

medias of the person

Show child attributes

relationships.medias.data

object[]

Show child attributes

relationships.medias.data.type

string

required

Allowed value: "media"

relationships.medias.data.id

string

required

UUID of an existing media or temp-id that references a media defined in the included array

included

object

Show child attributes

included.emails

object

Show child attributes

included.emails.data

object[]

Show child attributes

included.emails.data.type

string

required

Allowed value: "email"

included.emails.data.id

string

required

included.emails.data.attributes

object

required

Show child attributes

included.emails.data.attributes.value

string<email>

Email address value

Example:

"[email protected]"

included.emails.data.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

included.emails.data.attributes.label

enum<string>

default:work

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

Available options:

work,

personal,

other,

...

Example:

"work"

included.emails.data.attributes.created_at

string<date-time>

Timestamp when the email was created

Example:

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

included.emails.data.attributes.updated_at

string<date-time>

Timestamp when the email was last updated

Example:

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

included.phones

object

Show child attributes

included.phones.data

object[]

Show child attributes

included.phones.data.type

string

required

Allowed value: "phone"

included.phones.data.id

string

required

temp-id that references a phones defined in the included array

included.phones.data.attributes

object

required

Show child attributes

included.phones.data.attributes.number

string

required

Phone number in E164 format

Example:

"+14155552671"

included.phones.data.attributes.is_primary

boolean

default:true

Whether this is the primary phone number

included.phones.data.attributes.label

enum<string>

default:work

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

Available options:

work,

personal,

other,

...

included.web_links

object

Web links associated with this company

Show child attributes

included.web_links.data

object[]

Show child attributes

included.web_links.data.type

string

required

Allowed value: "web_link"

included.web_links.data.id

string

required

temp-id that references a web links defined in the included array

included.web_links.data.attributes

object

required

Show child attributes

included.web_links.data.attributes.url

string

required

Full profile URL

Required string length: 1 - 500

included.web_links.data.attributes.platform

enum<string>

Web platform type

Available options:

website,

linkedin,

x,

github

included.companies

object

Show child attributes

included.companies.data

object[]

Show child attributes

included.companies.data.type

string

required

Allowed value: "company"

included.companies.data.id

string

required

temp-id that references a companies defined in the included array

included.companies.data.attributes

object

required

Show child attributes

included.companies.data.attributes.registration

object

required

Option 1
Option 2

Show child attributes

included.companies.data.attributes.registration.registered_name

string

required

Legal company name

Example:

"TechCorp AI Solutions LLC"

included.companies.data.attributes.registration.trade_name

string

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

Example:

"TechSol"

included.companies.data.attributes.locale

string

Language settings.That’s the locale for the business relationship. Emails or documents can be used to identify the locale. Default EN.

Example:

"en-US"

included.companies.data.attributes.domain_name_primary_link_url

string<uri>

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

Example:

"https://www.techcorp.com"

included.companies.data.attributes.tax_id

object

Show child attributes

included.companies.data.attributes.tax_id.value

string

Tax ID issued by local or national tax authority.

Example:

"DE123456789"

included.companies.data.attributes.tax_id.type

string

Type of tax ID, useful for applying formatting and validation rules.all tax id types See all available labels for complete list.

Example:

["VAT", "TVA", "IVA", "..."]

included.companies.data.attributes.registration_number

object

Show child attributes

included.companies.data.attributes.registration_number.business_type

enum<string>

Legal entity structure type. See all business entity types for complete list.

Available options:

Inc,

Corp,

LLC,

GmbH,

Ltd,

SA,

SAS

Example:

"GmbH"

included.companies.data.attributes.registration_number.value

string

Official company registration number.

Example:

"HRB 123456"

included.companies.data.attributes.registration_number.registry_name

string

Name of the official registration body. See all available registry name for complete list.

Example:

"Handelsregister Berlin"

included.companies.data.attributes.registration_number.registry_country

string

Country of the registry authority. Must be valid ISO country code

Example:

"DE, FR, US, etc."

included.companies.data.attributes.description

string

Company description explaining business purpose in max 2 sentences.

Required string length: 1 - 500

Example:

"An innovative technology company focused on AI solutions"

included.workspaces

object

Workspaces associated with this company

Show child attributes

included.workspaces.data

object[]

Show child attributes

included.workspaces.data.type

string

required

Allowed value: "workspace"

included.workspaces.data.id

string

required

temp-id that references a workspaces defined in the included array

included.workspaces.data.attributes

object

required

Show child attributes

included.workspaces.data.attributes.name

string

required

Workspace name

Required string length: 1 - 255

included.workspaces.data.attributes.description

string

Workspace description

Maximum string length: 1000

included.workspaces.data.attributes.avatar_color

string

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

included.workspaces.data.attributes.external_workspace_id

string

External workspace identifier

Required string length: 1 - 255

included.documents

object

Documents associated with this company

Show child attributes

included.documents.data

object[]

Show child attributes

included.documents.data.type

string

Allowed value: "document"

included.documents.data.id

string

temp-id that references a documents defined in the included array

included.documents.data.attributes

object

Show child attributes

included.documents.data.attributes.file_name

string

included.documents.data.attributes.status

string

included.documents.data.attributes.file_type

string

included.documents.data.attributes.size_bytes

integer

included.memberships

object

membership associated with this person

Show child attributes

included.memberships.data

object[]

Show child attributes

included.memberships.data.type

string

Allowed value: "membership"

included.memberships.data.id

string

temp-id that references a memberships defined in the included array

included.memberships.data.attributes

object

Show child attributes

included.memberships.data.attributes.role

enum<string>

required

User role in the workspace. See all available roles for complete list.

Available options:

admin,

member,

owner,

...

included.memberships.data.attributes.firebase_id

string

included.medias

object

Media associated with this person

Show child attributes

included.medias.data

object[]

Show child attributes

included.medias.data.type

string

Allowed value: "membership"

included.medias.data.id

string

temp-id that references a medias defined in the included array

included.medias.data.attributes

object

Show child attributes

included.medias.data.attributes.media_type

enum<string>

Type of media (avatar, logo, banner)

Available options:

avatar,

logo,

banner

included.medias.data.attributes.is_primary

boolean

default:true

Marks preferred media. Default: true

Response

Person created 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

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

Delete Payment Mean Get Person

⌘I

Main Resources

Atomic Resources

System

Headers

Body

Response