Main Resources
Atomic Resources
System
curl --request GET \
--url https://api.wellapp.ai/v1/companies/{id} \
--header 'Authorization: <authorization>'{
"data": {
"type": "company",
"id": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
"attributes": {
"description": "Enterprise open source solutions company.",
"locale": "en",
"domain_name_primary_link_url": "acme.com",
"tax_id": {
"value": "DE123456789",
"type": "VAT"
},
"registration": {
"trade_name": "TechSol",
"registered_name": "Tech Solutions GmbH"
},
"registration_number": {
"business_type": "GmbH",
"value": "HRB 123456",
"registry_name": "Handelsregister Berlin",
"registry_country": "DE"
},
"created_at": "2025-09-30T14:30:00.000Z",
"updated_at": "2025-09-30T14:30:00.000Z"
},
"relationships": {
"created_by": {
"data": {
"type": "people",
"id": "6ba7b810-9dad-11d1-80b4-00c04fd430c8"
}
},
"media": {
"data": [
{
"type": "media",
"id": "550e8400-e29b-41d4-a716-446655440010"
}
]
},
"web_links": {
"data": [
{
"type": "web_link",
"id": "550e8400-e29b-41d4-a716-446655440011"
}
]
},
"emails": {
"data": [
{
"type": "email",
"id": "550e8400-e29b-41d4-a716-446655440012"
}
]
},
"phones": {
"data": [
{
"type": "phone",
"id": "550e8400-e29b-41d4-a716-446655440013"
}
]
},
"locations": {
"data": [
{
"type": "location",
"id": "550e8400-e29b-41d4-a716-446655440015"
}
]
},
"people": {
"data": [
{
"type": "people",
"id": "6ba7b810-9dad-11d1-80b4-00c04fd430c8"
}
]
},
"documents": {
"data": [
{
"type": "document",
"id": "550e8400-e29b-41d4-a716-446655440016"
}
]
},
"parents": {
"data": {
"type": "company",
"id": "550e8400-e29b-41d4-a716-446655440019"
}
},
"subsidiaries": {
"data": [
{
"type": "company",
"id": "550e8400-e29b-41d4-a716-446655440020"
}
]
},
"workspaces": {
"data": [
{
"type": "workspace",
"id": "550e8400-e29b-41d4-a716-446655440001"
}
]
}
}
},
"included": [
{
"type": "people",
"id": "6ba7b810-9dad-11d1-80b4-00c04fd430c8",
"attributes": {
"first_name": "Alexandre",
"last_name": "Dubois",
"full_name": "Alexandre Dubois",
"relationship_type": "owner"
}
},
{
"type": "workspace",
"id": "550e8400-e29b-41d4-a716-446655440001",
"attributes": {
"name": "Development Team",
"description": "Main development workspace for software engineering projects and client solutions",
"created_at": "2025-09-10T08:00:00.000Z",
"updated_at": "2025-09-15T16:45:00.000Z"
}
},
{
"type": "media",
"id": "550e8400-e29b-41d4-a716-446655440010",
"attributes": {
"file_name": "company_logo.png",
"content_type": "image/png",
"file_size": 15678
}
},
{
"type": "web_link",
"id": "550e8400-e29b-41d4-a716-446655440011",
"attributes": {
"url": "https://www.linkedin.com/company/acme",
"platform": "linkedin"
}
},
{
"type": "email",
"id": "550e8400-e29b-41d4-a716-446655440012",
"attributes": {
"value": "[email protected]",
"label": "work",
"is_primary": true
}
},
{
"type": "phone",
"id": "550e8400-e29b-41d4-a716-446655440013",
"attributes": {
"e164_number": "+4930123456789",
"label": "work",
"is_primary": true
}
},
{
"type": "location",
"id": "550e8400-e29b-41d4-a716-446655440015",
"attributes": {
"street": "Unter den Linden 1",
"city": "Berlin",
"postal_code": "10117",
"country": "DE",
"is_primary": true
}
},
{
"type": "document",
"id": "550e8400-e29b-41d4-a716-446655440016",
"attributes": {
"name": "company_registration.pdf",
"file_size": 245678,
"content_type": "application/pdf",
"created_at": "2025-09-25T10:00:00.000Z"
}
},
{
"type": "company",
"id": "550e8400-e29b-41d4-a716-446655440019",
"attributes": {
"name": "ACME Global Holdings",
"description": "Parent company of ACME",
"registration": {
"registered_name": "ACME Global Holdings GmbH"
}
}
},
{
"type": "company",
"id": "550e8400-e29b-41d4-a716-446655440020",
"attributes": {
"name": "ACME France",
"description": "French subsidiary of ACME",
"registration": {
"registered_name": "ACME France SAS"
}
}
}
]
}Get Company by id
Retrieve a specific company by ID
curl --request GET \
--url https://api.wellapp.ai/v1/companies/{id} \
--header 'Authorization: <authorization>'{
"data": {
"type": "company",
"id": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
"attributes": {
"description": "Enterprise open source solutions company.",
"locale": "en",
"domain_name_primary_link_url": "acme.com",
"tax_id": {
"value": "DE123456789",
"type": "VAT"
},
"registration": {
"trade_name": "TechSol",
"registered_name": "Tech Solutions GmbH"
},
"registration_number": {
"business_type": "GmbH",
"value": "HRB 123456",
"registry_name": "Handelsregister Berlin",
"registry_country": "DE"
},
"created_at": "2025-09-30T14:30:00.000Z",
"updated_at": "2025-09-30T14:30:00.000Z"
},
"relationships": {
"created_by": {
"data": {
"type": "people",
"id": "6ba7b810-9dad-11d1-80b4-00c04fd430c8"
}
},
"media": {
"data": [
{
"type": "media",
"id": "550e8400-e29b-41d4-a716-446655440010"
}
]
},
"web_links": {
"data": [
{
"type": "web_link",
"id": "550e8400-e29b-41d4-a716-446655440011"
}
]
},
"emails": {
"data": [
{
"type": "email",
"id": "550e8400-e29b-41d4-a716-446655440012"
}
]
},
"phones": {
"data": [
{
"type": "phone",
"id": "550e8400-e29b-41d4-a716-446655440013"
}
]
},
"locations": {
"data": [
{
"type": "location",
"id": "550e8400-e29b-41d4-a716-446655440015"
}
]
},
"people": {
"data": [
{
"type": "people",
"id": "6ba7b810-9dad-11d1-80b4-00c04fd430c8"
}
]
},
"documents": {
"data": [
{
"type": "document",
"id": "550e8400-e29b-41d4-a716-446655440016"
}
]
},
"parents": {
"data": {
"type": "company",
"id": "550e8400-e29b-41d4-a716-446655440019"
}
},
"subsidiaries": {
"data": [
{
"type": "company",
"id": "550e8400-e29b-41d4-a716-446655440020"
}
]
},
"workspaces": {
"data": [
{
"type": "workspace",
"id": "550e8400-e29b-41d4-a716-446655440001"
}
]
}
}
},
"included": [
{
"type": "people",
"id": "6ba7b810-9dad-11d1-80b4-00c04fd430c8",
"attributes": {
"first_name": "Alexandre",
"last_name": "Dubois",
"full_name": "Alexandre Dubois",
"relationship_type": "owner"
}
},
{
"type": "workspace",
"id": "550e8400-e29b-41d4-a716-446655440001",
"attributes": {
"name": "Development Team",
"description": "Main development workspace for software engineering projects and client solutions",
"created_at": "2025-09-10T08:00:00.000Z",
"updated_at": "2025-09-15T16:45:00.000Z"
}
},
{
"type": "media",
"id": "550e8400-e29b-41d4-a716-446655440010",
"attributes": {
"file_name": "company_logo.png",
"content_type": "image/png",
"file_size": 15678
}
},
{
"type": "web_link",
"id": "550e8400-e29b-41d4-a716-446655440011",
"attributes": {
"url": "https://www.linkedin.com/company/acme",
"platform": "linkedin"
}
},
{
"type": "email",
"id": "550e8400-e29b-41d4-a716-446655440012",
"attributes": {
"value": "[email protected]",
"label": "work",
"is_primary": true
}
},
{
"type": "phone",
"id": "550e8400-e29b-41d4-a716-446655440013",
"attributes": {
"e164_number": "+4930123456789",
"label": "work",
"is_primary": true
}
},
{
"type": "location",
"id": "550e8400-e29b-41d4-a716-446655440015",
"attributes": {
"street": "Unter den Linden 1",
"city": "Berlin",
"postal_code": "10117",
"country": "DE",
"is_primary": true
}
},
{
"type": "document",
"id": "550e8400-e29b-41d4-a716-446655440016",
"attributes": {
"name": "company_registration.pdf",
"file_size": 245678,
"content_type": "application/pdf",
"created_at": "2025-09-25T10:00:00.000Z"
}
},
{
"type": "company",
"id": "550e8400-e29b-41d4-a716-446655440019",
"attributes": {
"name": "ACME Global Holdings",
"description": "Parent company of ACME",
"registration": {
"registered_name": "ACME Global Holdings GmbH"
}
}
},
{
"type": "company",
"id": "550e8400-e29b-41d4-a716-446655440020",
"attributes": {
"name": "ACME France",
"description": "French subsidiary of ACME",
"registration": {
"registered_name": "ACME France SAS"
}
}
}
]
}Headers
Bearer token for authentication
Path Parameters
UUID of the company to retrieve
Response
Company retrieved successfully
Show child attributes
Show child attributes
"company"UUID of the created company
"550e8400-e29b-41d4-a716-446655440000"
Show child attributes
Show child attributes
The domain url from the website or email address of the company. Used as unique identifier in some cases.
500Show child attributes
Show child attributes
Legal entity structure type.
Official company registration number.
Name of the official registration body.
Country of the registry authority. (string (ISO 3166-1 alpha-2))
UUID of the workspace associated with this company
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
"people"UUID of the person
"550e8400-e29b-41d4-a716-446655440008"
Object containing included resources referenced in relationships, organized by resource type. These are the actual created/linked resources with real UUIDs.
Show child attributes
Show child attributes
Person who created this company
Show child attributes
Show child attributes
Show child attributes
Show child attributes
"people"UUID of the person
Show child attributes
Show child attributes
The person's first name
The person's last name
The person's full name (typically first_name + last_name)
Timestamp when the person was created
Timestamp when the person was last updated
Person associated with the company
Show child attributes
Show child attributes
Show child attributes
Show child attributes
"people"UUID of the person
Show child attributes
Show child attributes
The person's first name
The person's last name
The person's full name (typically first_name + last_name)
Timestamp when the person was created
Timestamp when the person was last updated
Parent company of this company
Show child attributes
Show child attributes
Show child attributes
Show child attributes
"company"UUID of the parent company
Show child attributes
Show child attributes
The domain url from the website or email address of the company. Used as unique identifier in some cases.
500Show child attributes
Show child attributes
Legal entity structure type.
Official company registration number.
Name of the official registration body.
Country of the registry authority. (string (ISO 3166-1 alpha-2))
UUID of the workspace associated with this company
Subsidiary companies of this company
Show child attributes
Show child attributes
Show child attributes
Show child attributes
"company"UUID of the subsidiary company
Show child attributes
Show child attributes
The domain url from the website or email address of the company. Used as unique identifier in some cases.
500Show child attributes
Show child attributes
Legal entity structure type.
Official company registration number.
Name of the official registration body.
Country of the registry authority. (string (ISO 3166-1 alpha-2))
UUID of the workspace associated with this company
Workspaces associated with this company
Show child attributes
Show child attributes
Show child attributes
Show child attributes
"workspace"UUID of the workspace
Show child attributes
Show child attributes
Workspace name
Workspace description
external workspace id
Color of the avatar
Timestamp when the workspace was created
Timestamp when the workspace was last updated
Email addresses associated with this company
Show child attributes
Show child attributes
Show child attributes
Show child attributes
"email"UUID of the email
Show child attributes
Show child attributes
Email address value
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.
true
Email label type. See all available labels for complete list.
work, personal, other, ... "work"
Timestamp when the email was created
"2023-06-15T10:30:00Z"
Timestamp when the email was last updated
"2023-06-15T10:30:00Z"
Phone numbers associated with this company
Show child attributes
Show child attributes
Show child attributes
Show child attributes
"phone"UUID of the phone
Show child attributes
Show child attributes
Full international phone number in E164 format
"+14155552671"
Phone label type. See all available labels for complete list.
work, personal, other, ... Whether this is the primary phone number
Timestamp when the phone was created
Locations/addresses associated with this company
Show child attributes
Show child attributes
Show child attributes
Show child attributes
"location"UUID of the location
Show child attributes
Show child attributes
Complete formatted address
Primary address line
Secondary address line
City name
State, province, or region
Postal or ZIP code
Two-letter ISO country code
Geographic latitude coordinate
Geographic longitude coordinate
Whether this is the primary location
Whether this is a registered business address
Custom label for the location
Date and time when the location was created
Date and time when the location was last updated
Media files associated with this company
Show child attributes
Show child attributes
Show child attributes
Show child attributes
"media"UUID of the media
Show child attributes
Show child attributes
avatar, logo, banner URL to the media file
Whether this is the primary media
Timestamp when media processing completed
Web links associated with this company
Show child attributes
Show child attributes
Show child attributes
Show child attributes
"web_link"UUID of the web link
Show child attributes
Show child attributes
Web platform type
website, linkedin, x, github Full profile URL
Date and time when the web link was created
Date and time when the web link was updated
Documents associated with this company
Show child attributes
Show child attributes
Show child attributes
Show child attributes
"document"UUID of the document
Show child attributes
Show child attributes