Get web-Link by id

Headers

Authorization

string

required

Bearer token for authentication

Path Parameters

string<uuid>

required

Web link ID to retrieve

Query Parameters

include

string

Comma-separated list of relationships to include detailed data for. Available options: workspace, persons, companies

Response

Web link retrieved successfully

data

object

Show child attributes

data.type

string

Example:

"web_link"

data.id

string<uuid>

data.attributes

object

Show child attributes

data.attributes.platform

enum<string>

Web platform type

Available options:

website,

linkedin,

x,

github

data.attributes.url

string

Full profile URL

data.attributes.created_at

string<date-time>

Date and time when the web link was created

data.attributes.updated_at

string<date-time>

Date and time when the web link was updated

data.relationships

object

Show child attributes

data.relationships.persons

object

Show child attributes

data.relationships.persons.data

object[]

Show child attributes

data.relationships.persons.data.type

enum<string>

Available options:

people

data.relationships.persons.data.id

string

Person ID

data.relationships.persons.data.attributes

object

Person attribute data

Show child attributes

data.relationships.persons.data.attributes.first_name

string

required

Person's first name

Required string length: 1 - 100

Example:

"Marie"

data.relationships.persons.data.attributes.last_name

string

required

Person's last name

Required string length: 1 - 100

Example:

"Dubois"

data.relationships.persons.data.attributes.created_at

string<date-time>

required

Person creation timestamp (UTC)

Example:

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

data.relationships.persons.data.attributes.full_name

string

Auto-computed full name (first + last)

Example:

"Marie Dubois"

data.relationships.persons.data.attributes.updated_at

string<date-time> | null

Last modification timestamp (UTC)

Example:

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

data.relationships.companies

object

Show child attributes

data.relationships.companies.data

object[]

Show child attributes

data.relationships.companies.data.type

enum<string>

Available options:

company

data.relationships.companies.data.id

string

Company ID

data.relationships.companies.data.attributes

object

Show child attributes

data.relationships.companies.data.attributes.description

string

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

object

Show child attributes

data.relationships.companies.data.attributes.tax_id.value

string

Tax ID issued by local or national tax authority.

data.relationships.companies.data.attributes.tax_id.type

string

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

data.relationships.companies.data.attributes.registration

object

Show child attributes

data.relationships.companies.data.attributes.registration.trade_name

string

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

data.relationships.companies.data.attributes.registration.registered_name

string

Legal company name.

Required string length: 1 - 100

data.relationships.companies.data.attributes.registration_number

object

Show child attributes

data.relationships.companies.data.attributes.registration_number.business_type

string

Legal entity structure type.

data.relationships.companies.data.attributes.registration_number.value

string

Official company registration number.

data.relationships.companies.data.attributes.registration_number.registry_name

string

Name of the official registration body.

data.relationships.companies.data.attributes.registration_number.registry_country

string

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

data.relationships.companies.data.attributes.workspace_id

string<uuid>

UUID of the workspace associated with this company

data.relationships.companies.data.attributes.created_at

string<date-time>

data.relationships.companies.data.attributes.updated_at

string<date-time>

data.relationships.workspaces

object

Show child attributes

data.relationships.workspaces.data

object[]

Show child attributes

data.relationships.workspaces.data.type

enum<string>

Available options:

workspace

data.relationships.workspaces.data.id

string

Workspace ID

data.relationships.workspaces.data.attributes

object

Show child attributes

data.relationships.workspaces.data.attributes.name

string

Workspace name

data.relationships.workspaces.data.attributes.desription

string

Workspace description

data.relationships.workspaces.data.attributes.external_workspace_id

string<uuid>

external workspace id

data.relationships.workspaces.data.attributes.avatar_color

string<colors>

Color of the avatar

data.relationships.workspaces.data.attributes.created_at

string<date-time>

Timestamp when the workspace was created

data.relationships.workspaces.data.attributes.updated_at

string<date-time>

Timestamp when the workspace was last updated

Main Resources

Atomic Resources

System

Headers

Path Parameters

Query Parameters

Response