How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Square Team API

The Team API from Square — 8 operation(s) for team.

Square Team API is one of 45 APIs that Square publishes on the APIs.io network, described by a machine-readable OpenAPI specification and an AsyncAPI event-driven specification.

Tagged areas include Team. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, and an AsyncAPI specification.

This API exposes 12 operations across 8 paths, and defines 35 schemas. It is described by OpenAPI 3.2.0, at version 2.0.

Requests are made against a single base URL, https://connect.squareup.com.

12 operations 8 paths 35 schemas 4 GET5 POST3 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
2.0
Server
https://connect.squareup.com
Authentication
OAuth 2.0, API Key
License
Terms of Service
Resource Areas
1

Authentication & Security 2

Square Team API declares 2 security schemes for authenticating requests. It supports OAuth 2.0 (oauth2) using the authorizationCode flow, exposing 57 scopes. An API key is passed in the header as Authorization (oauth2ClientSecret).

Paths & Operations 12

Across 8 paths, the API surfaces 12 operations — 4 GET, 5 POST, 3 PUT. Each is listed below with its method, path, parameters, and response codes.

Team 12
POST
/v2/team-members
Square Create Team Member
CreateTeamMember body → 200
POST
/v2/team-members/bulk-create
Square Bulk Create Team Members
BulkCreateTeamMembers body → 200
POST
/v2/team-members/bulk-update
Square Bulk Update Team Members
BulkUpdateTeamMembers body → 200
GET
/v2/team-members/jobs
Square List Jobs
ListJobs 1 param → 200
POST
/v2/team-members/jobs
Square Create Job
CreateJob body → 200
GET
/v2/team-members/jobs/{job_id}
Square Retrieve Job
RetrieveJob 1 param → 200
PUT
/v2/team-members/jobs/{job_id}
Square Update Job
UpdateJob 1 param body → 200
POST
/v2/team-members/search
Square Search Team Members
SearchTeamMembers body → 200
GET
/v2/team-members/{team_member_id}
Square Retrieve Team Member
RetrieveTeamMember 1 param → 200
PUT
/v2/team-members/{team_member_id}
Square Update Team Member
UpdateTeamMember 1 param body → 200
GET
/v2/team-members/{team_member_id}/wage-setting
Square Retrieve Wage Setting
RetrieveWageSetting 1 param → 200
PUT
/v2/team-members/{team_member_id}/wage-setting
Square Update Wage Setting
UpdateWageSetting 1 param body → 200

Schemas 35

The contract defines 35 schemas that model the data the API accepts and returns. The most detailed are TeamMember (12 properties), Job (6 properties), JobAssignment (6 properties), WageSetting (6 properties). Each schema is shown below with its type and property counts.

Currency
string
Indicates the associated currency for an amount of money. Values correspond to [ISO 4217](https://wikipedia.org/wiki/ISO4217).
RetrieveJobResponse
object
Represents a [RetrieveJob](api-endpoint:Team-RetrieveJob) response. Either job or errors is present in the response.
2 properties
RetrieveWageSettingResponse
object
Represents a response from a retrieve request containing the specified WageSetting object or error messages.
2 properties
SearchTeamMembersQuery
object
Represents the parameters in a search for TeamMember objects.
1 property
TeamMemberAssignedLocationsAssignmentType
string
Enumerates the possible assignment types that the team member can have.
UpdateJobResponse
object
Represents an [UpdateJob](api-endpoint:Team-UpdateJob) response. Either job or errors is present in the response.
2 properties
UpdateWageSettingResponse
object
Represents a response from an update request containing the updated WageSetting object or error messages.
2 properties
UpdateTeamMemberRequest
object
Represents an update request for a TeamMember object.
1 property
BulkCreateTeamMembersRequest
object
Represents a bulk create request for TeamMember objects.
1 property 1 required
RetrieveTeamMemberResponse
object
Represents a response from a retrieve request containing a TeamMember object or error messages.
2 properties
UpdateWageSettingRequest
object
Represents an update request for the WageSetting object describing a TeamMember.
1 property 1 required
Money
object
Represents an amount of money. Money fields can be signed or unsigned. Fields that do not explicitly define whether they are signed or unsigned are considered…
2 properties
WageSetting
object
Represents information about the overtime exemption status, job assignments, and compensation for a [team member](entity:TeamMember).
6 properties
BulkCreateTeamMembersResponse
object
Represents a response from a bulk create request containing the created TeamMember objects or error messages.
2 properties
TeamMember
object
A record representing an individual team member for a business.
12 properties
BulkUpdateTeamMembersResponse
object
Represents a response from a bulk update request containing the updated TeamMember objects or error messages.
2 properties
SearchTeamMembersResponse
object
Represents a response from a search request containing a filtered list of TeamMember objects.
3 properties
BulkUpdateTeamMembersRequest
object
Represents a bulk update request for TeamMember objects.
1 property 1 required
Job
object
Represents a job that can be assigned to [team members](entity:TeamMember). This object defines the job's title and tip eligibility. Compensation is defined in…
6 properties
TeamMemberAssignedLocations
object
An object that represents a team member's assignment to locations.
2 properties
UpdateTeamMemberResponse
object
Represents a response from an update request containing the updated TeamMember object or error messages.
2 properties
ListJobsResponse
object
Represents a [ListJobs](api-endpoint:Team-ListJobs) response. Either jobs or errors is present in the response. If additional results are available, the cursor…
3 properties
JobAssignment
object
Represents a job assigned to a [team member](entity:TeamMember), including the compensation the team member earns for the job. Job assignments are listed in th…
6 properties 1 required
Error
object
Represents an error encountered during a request to the Connect API. See [Handling errors](https://developer.squareup.com/docs/build-basics/handling-errors) fo…
4 properties 2 required
ErrorCode
string
Indicates the specific error that occurred during a request to a Square API.
SearchTeamMembersRequest
object
Represents a search request for a filtered list of TeamMember objects.
3 properties
TeamMemberStatus
string
Enumerates the possible statuses the team member can have within a business.
UpdateJobRequest
object
Represents an [UpdateJob](api-endpoint:Team-UpdateJob) request.
1 property 1 required
CreateTeamMemberResponse
object
Represents a response from a create request containing the created TeamMember object or error messages.
2 properties
CreateTeamMemberRequest
object
Represents a create request for a TeamMember object.
2 properties
SearchTeamMembersFilter
object
Represents a filter used in a search for TeamMember objects. AND logic is applied between the individual fields, and OR logic is applied within list-based fiel…
3 properties
ErrorCategory
string
Indicates which high-level category of error has occurred during a request to the Connect API.
CreateJobResponse
object
Represents a [CreateJob](api-endpoint:Team-CreateJob) response. Either job or errors is present in the response.
2 properties
CreateJobRequest
object
Represents a [CreateJob](api-endpoint:Team-CreateJob) request.
2 properties 2 required
JobAssignmentPayType
string
Enumerates the possible pay types that a job can be assigned.

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

square-team-api-openapi.yml Raw ↑

Other APIs Square publishes across the network.

Square Reporting API
Square Channels API
Square Transfer Orders API
Square ApplePay API
Square BankAccounts API
Square BookingCustomAttributes API
Square Bookings API
Square Cards API
Square CashDrawers API
Square Catalog API
Square Checkout API
Square CustomerCustomAttributes API
Where this information came from

This is an independent, third-party profile of Square Team API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.