Skip to content

Latest commit

 

History

History
38 lines (29 loc) · 2.9 KB

team-member.md

File metadata and controls

38 lines (29 loc) · 2.9 KB

Team Member

A record representing an individual team member for a business.

Structure

TeamMember

Fields

Name Type Tags Description Getter Setter
id ?string Optional The unique ID for the team member. getId(): ?string setId(?string id): void
referenceId ?string Optional A second ID used to associate the team member with an entity in another system. getReferenceId(): ?string setReferenceId(?string referenceId): void
isOwner ?bool Optional Whether the team member is the owner of the Square account. getIsOwner(): ?bool setIsOwner(?bool isOwner): void
status ?string(TeamMemberStatus) Optional Enumerates the possible statuses the team member can have within a business. getStatus(): ?string setStatus(?string status): void
givenName ?string Optional The given name (that is, the first name) associated with the team member. getGivenName(): ?string setGivenName(?string givenName): void
familyName ?string Optional The family name (that is, the last name) associated with the team member. getFamilyName(): ?string setFamilyName(?string familyName): void
emailAddress ?string Optional The email address associated with the team member. After accepting the invitation
from Square, only the team member can change this value.		 getEmailAddress(): ?string setEmailAddress(?string emailAddress): void
phoneNumber ?string Optional The team member's phone number, in E.164 format. For example:
+14155552671 - the country code is 1 for US
+551155256325 - the country code is 55 for BR		 getPhoneNumber(): ?string setPhoneNumber(?string phoneNumber): void
createdAt ?string Optional The timestamp when the team member was created, in RFC 3339 format. getCreatedAt(): ?string setCreatedAt(?string createdAt): void
updatedAt ?string Optional The timestamp when the team member was last updated, in RFC 3339 format. getUpdatedAt(): ?string setUpdatedAt(?string updatedAt): void
assignedLocations ?TeamMemberAssignedLocations Optional An object that represents a team member's assignment to locations. getAssignedLocations(): ?TeamMemberAssignedLocations setAssignedLocations(?TeamMemberAssignedLocations assignedLocations): void
wageSetting ?WageSetting Optional Represents information about the overtime exemption status, job assignments, and compensation
for a team member.		 getWageSetting(): ?WageSetting setWageSetting(?WageSetting wageSetting): void

Example (as JSON)

{
  "id": "id4",
  "reference_id": "reference_id8",
  "is_owner": false,
  "status": "ACTIVE",
  "given_name": "given_name6"
}