Interfaces

Interfaces define the structure of a type, and include a set of fields that are required for a type to implement the interface.

Account

A Worksome account.

An account represents an entity that can interact with the platform. Account types include Company (the hiring entity), Organisation (a parent grouping of companies), Partner (an employment or compliance partner), Worker (a freelancer or contractor), and Staffing Agency (recruiter).

Fields
`id`ID! The ID of the account.
`name`String! The name of the account.
`avatar`URL The avatar (or profile picture) for the account.

ClientRelation

Experimental. A supplier’s relation with one client company.

Fields
`id`ID! The ID of the relation.
`client`Company! The client company.
`createdAt`Date! When the relation was created.
`hiresCount`Int! Experimental. How many placements the relation has, counting only the given statuses when set.
`workersCount`Int! Experimental. How many distinct workers the relation has placed at the client.
`firstHireStartedAt`Date Experimental. When the relation’s earliest placement at the client started. Null before the first one.

HasCompanyInformation

An interface requiring company-specific fields.

Fields
`name`String! The name of the account.
`market`MarketCode! The market that the account is in.

HasCustomFields

An interface requiring custom fields specific data.

Fields
`customFields`CustomFieldPaginator! A list of owned custom fields.

HasMultiFactorMetadata

The consistent data for a multi factor implementation.

Fields
`id`ID! The ID of the multi-factor authentication implementation.
`name`String! The name of the multi-factor authentication implementation.
`status`MultiFactorStatus! The status of the multi-factor authentication implementation.
`owner`User! The owner of the multi-factor authentication implementation.
`verifiedAt`DateTime When the SMS multi-factor authentication implementation was verified.
`createdAt`DateTime! When the SMS multi-factor authentication implementation was created.
`updatedAt`DateTime! When the SMS multi-factor authentication implementation was updated.

HasURL

An interface requiring a URL field.

Fields
`url`URL! The URL for the resource.

Ownable

A record that people can be assigned to as owners.

Fields
`id`ID! The record’s own ID.
`owners`[Owner!]! The team members assigned to this record.
`viewerCanManageOwners`Boolean! Whether the viewer may change the owners of this record.

WorkflowVariable

A variable that can be used in approval rule conditions.

Workflow variables represent the data points available for building conditions in approval rules. They include system variables (e.g. hourly rate, daily rate, budget) and company-configured custom fields. Each variable defines which comparison operators it supports.

Fields
`id`ID! The ID for this variable, used when creating rule conditions.
`title`String! The human-readable title of the variable (e.g. “Hourly Rate”, “Budget”).
`description`String A description of what the variable represents.
`operators`[WorkflowVariableOperator!]! The comparison operators that can be used with this variable (e.g. equals, greater than).