Get Companies

Complex Usage Example

Advanced Company Filtering with Full Context

This example demonstrates advanced filtering with multiple parameters, relationship inclusion, business entity filtering, sorting, and pagination for retrieving companies:

curl -X GET "https://api.well.com/v1/companies?include=peoples,workspaces,emails,phones,web_links,locations,documents,media,categories,parents,subsidiaries&filter[workspace_id]=550e8400-e29b-41d4-a716-446655440000&filter[name]=TechCorp&filter[business_entity]=GmbH&filter[registration_tax_id]=12345678901&filter[registration_registered_value]=123456789&filter[country]=DE&filter[people_id]=550e8400-e29b-41d4-a716-446655440001&filter[email][email protected]&filter[phone_number]=+491234567890&filter[has_logo]=true&filter[created_at_from]=2024-01-01T00:00:00Z&filter[created_at_to]=2024-12-31T23:59:59Z&filter[updated_at_from]=2024-06-01T00:00:00Z&sort=-created_at&page[limit]=25&page[cursor]=eyJjcmVhdGVkX2F0IjoiMjAyNS0xMS0wMlQxMDozMDowMFoiLCJpZCI6ImNvbXBhbnk5LXV1aWQifQ==" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json"

This comprehensive query will:

Include relationships: Retrieve complete data for people, workspaces, contact information, and documents
Filter by workspace: Limit to companies in a specific workspace
Search by name: Find companies with “TechCorp” in their name
Filter by business entity: Only show German GmbH companies
Registration filtering: Filter by tax ID and registration numbers
Geographic filtering: Limit to companies in Germany
Contact filtering: Find companies with specific email or phone
Media filtering: Only show companies with logos
Date range filtering: Limit to companies created/updated in specific periods
Sorting: Order by creation date (newest first)
Pagination: Get 25 results per page with cursor-based pagination

Headers

Authorization

string

required

Bearer token for authentication

Query Parameters

include

enum<string>

Include detailed relationship data in the response. Comma-separated values supported.

Available options:

workspace,

company,

people,

documents,

created_by,

medias,

web_links,

emails,

phones,

categories,

locations,

people,

parents,

subsidiaries

filter[created_at_from]

string<date-time>

Filter companies created on or after this date

filter[created_at_to]

string<date-time>

Filter companies created on or before this date

filter[updated_at_from]

string<date-time>

Filter companies updated on or after this date

filter[updated_at_to]

string<date-time>

Filter companies updated on or before this date

filter[created_by]

string<uuid>[]

Filter companies by creator ID(s)

filter[workspace_id]

string<uuid>[]

Filter companies by workspace ID(s)

filter[external_workspace_id]

string[]

Filter companies by external workspace ID(s)

filter[emails]

string<email>[]

Filter companies by email address(es)

filter[phone]

string[]

Filter companies by phone number(s)

filter[parent_registration]

string[]

Filter companies by parent registration number(s)

filter[documents_id]

string<uuid>[]

Filter companies by associated document ID(s)

filter[parents_company_id]

string<uuid>[]

Filter companies by parent company ID(s)

filter[parents_company_tax_id_value]

string[]

Filter companies by parent company tax ID value(s)

filter[parents_company_registration_registered_value]

string[]

Filter companies by parent company registration value(s)

filter[domain_name_primary_link_url]

string<uri>[]

Filter companies by primary domain URL(s)

sort

enum<string>

Sort companies by field. Use - prefix for descending order.

Available options:

created_at,

-created_at,

updated_at,

-updated_at,

issue_date,

-issue_date,

due_date,

-due_date

Response

Companies retrieved successfully

data

object[]

Show child attributes

data.type

string

Allowed value: "company"

data.id

string<uuid>

UUID of the created company

Example:

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

data.attributes

object

Show child attributes

data.attributes.description

string

data.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.attributes.tax_id

object

Show child attributes

data.attributes.tax_id.value

string

Tax ID issued by local or national tax authority.

data.attributes.tax_id.type

string

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

data.attributes.registration

object

Show child attributes

data.attributes.registration.trade_name

string

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

data.attributes.registration.registered_name

string

Legal company name.

Required string length: 1 - 100

data.attributes.registration_number

object

Show child attributes

data.attributes.registration_number.business_type

string

Legal entity structure type.

data.attributes.registration_number.value

string

Official company registration number.

data.attributes.registration_number.registry_name

string

Name of the official registration body.

data.attributes.registration_number.registry_country

string

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

data.attributes.workspace_id

string<uuid>

UUID of the workspace associated with this company

data.attributes.created_at

string<date-time>

data.attributes.updated_at

string<date-time>

data.relationships

object

Show child attributes

data.relationships.created_by

object

Show child attributes

data.relationships.created_by.data

object

Show child attributes

data.relationships.created_by.data.type

string

Allowed value: "people"

data.relationships.created_by.data.id

string<uuid>

UUID of the person who created this company

Example:

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

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.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>

UUID of the web link

Example:

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

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>

UUID of the email

Example:

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

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>

UUID of the phone

Example:

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

data.relationships.locations

object

Show child attributes

data.relationships.locations.data

object[]

Show child attributes

data.relationships.locations.data.type

string

Allowed value: "location"

data.relationships.locations.data.id

string<uuid>

UUID of the location

Example:

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

data.relationships.people

object

Show child attributes

data.relationships.people.data

object[]

Show child attributes

data.relationships.people.data.type

string

Allowed value: "people"

data.relationships.people.data.id

string<uuid>

UUID of the person

Example:

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

data.relationships.people.data.meta

object

Show child attributes

data.relationships.people.data.meta.relationship_type

enum<string>

Relationship type of the person in the company

Available options:

contact,

employee,

owner,

other

Example:

"employee"

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.relationships.parents

object

Show child attributes

data.relationships.parents.data

object[]

Show child attributes

data.relationships.parents.data.type

string

Allowed value: "company"

data.relationships.parents.data.id

string<uuid>

UUID of the parent company

Example:

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

data.relationships.subsidiaries

object

Show child attributes

data.relationships.subsidiaries.data

object[]

Show child attributes

data.relationships.subsidiaries.data.type

string

Allowed value: "company"

data.relationships.subsidiaries.data.id

string<uuid>

UUID of the subsidiary company

Example:

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

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

object

Object containing included resources referenced in relationships, organized by resource type. These are the actual created/linked resources with real UUIDs.

Show child attributes

data.included.created_by

object

Person who created this company

Show child attributes

data.included.created_by.data

object

Show child attributes

data.included.created_by.data.type

string

Allowed value: "people"

data.included.created_by.data.id

string<uuid>

UUID of the person

data.included.created_by.data.attributes

object

Show child attributes

data.included.created_by.data.attributes.first_name

string

The person's first name

data.included.created_by.data.attributes.last_name

string

The person's last name

data.included.created_by.data.attributes.full_name

string

The person's full name (typically first_name + last_name)

data.included.created_by.data.attributes.created_at

string<date-time>

Timestamp when the person was created

data.included.created_by.data.attributes.updated_at

string<date-time>

Timestamp when the person was last updated

data.included.people

object

Person associated with the company

Show child attributes

data.included.people.data

object

Show child attributes

data.included.people.data.type

string

Allowed value: "people"

data.included.people.data.id

string<uuid>

UUID of the person

data.included.people.data.attributes

object

Show child attributes

data.included.people.data.attributes.first_name

string

The person's first name

data.included.people.data.attributes.last_name

string

The person's last name

data.included.people.data.attributes.full_name

string

The person's full name (typically first_name + last_name)

data.included.people.data.attributes.created_at

string<date-time>

Timestamp when the person was created

data.included.people.data.attributes.updated_at

string<date-time>

Timestamp when the person was last updated

data.included.parents

object

Parent company of this company

Show child attributes

data.included.parents.data

object

Show child attributes

data.included.parents.data.type

string

Allowed value: "company"

data.included.parents.data.id

string<uuid>

UUID of the parent company

data.included.parents.data.attributes

object

Show child attributes

data.included.parents.data.attributes.description

string

data.included.parents.data.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.parents.data.attributes.tax_id

object

Show child attributes

data.included.parents.data.attributes.tax_id.value

string

Tax ID issued by local or national tax authority.

data.included.parents.data.attributes.tax_id.type

string

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

data.included.parents.data.attributes.registration

object

Show child attributes

data.included.parents.data.attributes.registration.trade_name

string

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

data.included.parents.data.attributes.registration.registered_name

string

Legal company name.

Required string length: 1 - 100

data.included.parents.data.attributes.registration_number

object

Show child attributes

data.included.parents.data.attributes.registration_number.business_type

string

Legal entity structure type.

data.included.parents.data.attributes.registration_number.value

string

Official company registration number.

data.included.parents.data.attributes.registration_number.registry_name

string

Name of the official registration body.

data.included.parents.data.attributes.registration_number.registry_country

string

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

data.included.parents.data.attributes.workspace_id

string<uuid>

UUID of the workspace associated with this company

data.included.parents.data.attributes.created_at

string<date-time>

data.included.parents.data.attributes.updated_at

string<date-time>

data.included.subsidiaries

object

Subsidiary companies of this company

Show child attributes

data.included.subsidiaries.data

object[]

Show child attributes

data.included.subsidiaries.data.type

string

Allowed value: "company"

data.included.subsidiaries.data.id

string<uuid>

UUID of the subsidiary company

data.included.subsidiaries.data.attributes

object

Show child attributes

data.included.subsidiaries.data.attributes.description

string

data.included.subsidiaries.data.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.subsidiaries.data.attributes.tax_id

object

Show child attributes

data.included.subsidiaries.data.attributes.tax_id.value

string

Tax ID issued by local or national tax authority.

data.included.subsidiaries.data.attributes.tax_id.type

string

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

data.included.subsidiaries.data.attributes.registration

object

Show child attributes

data.included.subsidiaries.data.attributes.registration.trade_name

string

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

data.included.subsidiaries.data.attributes.registration.registered_name

string

Legal company name.

Required string length: 1 - 100

data.included.subsidiaries.data.attributes.registration_number

object

Show child attributes

data.included.subsidiaries.data.attributes.registration_number.business_type

string

Legal entity structure type.

data.included.subsidiaries.data.attributes.registration_number.value

string

Official company registration number.

data.included.subsidiaries.data.attributes.registration_number.registry_name

string

Name of the official registration body.

data.included.subsidiaries.data.attributes.registration_number.registry_country

string

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

data.included.subsidiaries.data.attributes.workspace_id

string<uuid>

UUID of the workspace associated with this company

data.included.subsidiaries.data.attributes.created_at

string<date-time>

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

Workspace name

data.included.workspaces.data.attributes.desription

string

Workspace description

data.included.workspaces.data.attributes.external_workspace_id

string<uuid>

external workspace id

data.included.workspaces.data.attributes.avatar_color

string<colors>

Color of the avatar

data.included.workspaces.data.attributes.created_at

string<date-time>

Timestamp when the workspace was created

data.included.workspaces.data.attributes.updated_at

string<date-time>

Timestamp when the workspace was last updated

data.included.emails

object

Email addresses associated with this company

Show child attributes

data.included.emails.data

object[]

Show child attributes

data.included.emails.data.type

string

required

Allowed value: "email"

data.included.emails.data.id

string<uuid>

required

UUID of the email

data.included.emails.data.attributes

object

required

Show child attributes

data.included.emails.data.attributes.value

string<email>

Email address value

Example:

"[email protected]"

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

data.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"

data.included.emails.data.attributes.created_at

string<date-time>

Timestamp when the email was created

Example:

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

data.included.emails.data.attributes.updated_at

string<date-time>

Timestamp when the email was last updated

Example:

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

data.included.phones

object

Phone numbers associated with this company

Show child attributes

data.included.phones.data

object[]

Show child attributes

data.included.phones.data.type

string

Allowed value: "phone"

data.included.phones.data.id

string<uuid>

UUID of the phone

data.included.phones.data.attributes

object

Show child attributes

data.included.phones.data.attributes.number

string

Full international phone number in E164 format

Example:

"+14155552671"

data.included.phones.data.attributes.label

enum<string>

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

Available options:

work,

personal,

other,

...

data.included.phones.data.attributes.is_primary

boolean

Whether this is the primary phone number

data.included.phones.data.attributes.created_at

string<date-time>

Timestamp when the phone was created

data.included.locations

object

Locations/addresses associated with this company

Show child attributes

data.included.locations.data

object[]

Show child attributes

data.included.locations.data.type

string

Allowed value: "location"

data.included.locations.data.id

string<uuid>

UUID of the location

data.included.locations.data.attributes

object

Show child attributes

data.included.locations.data.attributes.full_address

string

Complete formatted address

data.included.locations.data.attributes.address_line1

string

Primary address line

data.included.locations.data.attributes.address_line2

string

Secondary address line

data.included.locations.data.attributes.city

string

City name

data.included.locations.data.attributes.region

string

State, province, or region

data.included.locations.data.attributes.postal_code

string

Postal or ZIP code

data.included.locations.data.attributes.country

string

Two-letter ISO country code

data.included.locations.data.attributes.latitude

number<float>

Geographic latitude coordinate

data.included.locations.data.attributes.longitude

number<float>

Geographic longitude coordinate

data.included.locations.data.attributes.is_primary

boolean

Whether this is the primary location

data.included.locations.data.attributes.is_registered

boolean

Whether this is a registered business address

data.included.locations.data.attributes.label

string

Custom label for the location

data.included.locations.data.attributes.created_at

string<date-time>

Date and time when the location was created

data.included.locations.data.attributes.updated_at

string<date-time>

Date and time when the location was last updated

data.included.media

object

Media files associated with this company

Show child attributes

data.included.media.data

object[]

Show child attributes

data.included.media.data.type

string

Allowed value: "media"

data.included.media.data.id

string<uuid>

UUID of the media

data.included.media.data.attributes

object

Show child attributes

data.included.media.data.attributes.media_type

enum<string>

Available options:

avatar,

logo,

banner

data.included.media.data.attributes.url

string<uri>

URL to the media file

data.included.media.data.attributes.is_primary

boolean

Whether this is the primary media

data.included.media.data.attributes.processed_at

string<date-time>

Timestamp when media processing completed

data.included.media.data.attributes.uploaded_at

string<date-time>

data.included.web_links

object

Web links associated with this company

Show child attributes

data.included.web_links.data

object[]

Show child attributes

data.included.web_links.data.type

string

Allowed value: "web_link"

data.included.web_links.data.id

string<uuid>

UUID of the web link

data.included.web_links.data.attributes

object

Show child attributes

data.included.web_links.data.attributes.platform

enum<string>

Web platform type

Available options:

website,

linkedin,

x,

github

data.included.web_links.data.attributes.url

string

Full profile URL

data.included.web_links.data.attributes.created_at

string<date-time>

Date and time when the web link was created

data.included.web_links.data.attributes.updated_at

string<date-time>

Date and time when the web link was updated

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

Main Resources

Atomic Resources

System

Complex Usage Example

Advanced Company Filtering with Full Context

Headers

Query Parameters

Response

Main Resources

Atomic Resources

System

​Complex Usage Example

​Advanced Company Filtering with Full Context

Headers

Query Parameters

Response

Complex Usage Example

Advanced Company Filtering with Full Context