Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Wingspan Collaborator Management API

This category includes endpoints that manage relationships and interactions with collaborators. This includes collaborator settings, and various operations related to collaborators.

Wingspan Collaborator Management API is one of 15 APIs that Wingspan publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

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

This API exposes 17 operations across 10 paths, and defines 47 schemas. It is described by OpenAPI 3.1.0, at version 1.0.0-oas3.1.

Requests are made against 2 base URLs: https://api.wingspan.app, https://stagingapi.wingspan.app.

17 operations 10 paths 47 schemas 2 DELETE8 GET4 PATCH3 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
1.0.0-oas3.1
Base URL
https://api.wingspan.app
Authentication
HTTP Bearer
License
Terms of Service
Resource Areas
1

Authentication & Security 1

Wingspan Collaborator Management API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (JWT) (BearerAuth). By default, every request must be authenticated.

Paths & Operations 17

Across 10 paths, the API surfaces 17 operations — 2 DELETE, 8 GET, 4 PATCH, 3 POST. Each is listed below with its method, path, parameters, and response codes.

Collaborator Management 17

This category includes endpoints that manage relationships and interactions with collaborators. This includes collaborator settings, and various operations related to collaborator…

POST
/payments/collaborator-deduction
Register a New Deduction for a Collaborator
createDeductionCollaborator body → 200
GET
/payments/collaborator-deduction
Retrieve All Deductions for Collaborators
listDeductionCollaborators → 200
GET
/payments/collaborator-deduction/{id}
Retrieve Specific Deduction Details
getDeductionCollaborator 1 param → 200
PATCH
/payments/collaborator-deduction/{id}
Modify Details of a Specific Deduction
updateDeductionCollaborator 1 param body → 200
DELETE
/payments/collaborator-deduction/{id}
Erase a Specific Deduction Entry
deleteDeductionCollaborator 1 param → 200
GET
/payments/collaborator/{id}/events
Retrieve Events Associated with a Collaborator
getEventAssociatedCollaborator 1 param → 200
GET
/payments/collaborator/{id}
Retrieve Details of a Specific Collaborator
getCollaborator 1 param → 200
PATCH
/payments/collaborator/{id}
Modify Collaborator Details
updateCollaborator 1 param body → 200
DELETE
/payments/collaborator/{id}
Remove a Specific Collaborator Record
deleteCollaborator 1 param → 200
GET
/payments/collaborator
Retrieve All Registered Collaborators
listRegisteredCollaborators → 200
POST
/payments/collaborator
Register a New Collaborator
createCollaborator body → 200
PATCH
/payments/collaborator/{id}/add-group/{groupId}
Associate Collaborator with a Specific Group
associateCollaboratorWithGroup 2 params → 200
PATCH
/payments/collaborator/{id}/remove-group/{groupId}
Disassociate Collaborator from a Specific Group
disassociateCollaboratorWithGroup 2 params → 200
GET
/payments/collaborator-group
Retrieve All Collaborator Groups
listCollaboratorGroups → 200
POST
/payments/collaborator-group
Generate New Collaborator Group
createCollaboratorGroup body → 200
GET
/payments/v2/collaborator
Retrieve All Collaborators (Version 2)
listCollaborators → 200
GET
/payments/v2/collaborator/{memberId}
Retrieve Specific Collaborator Details (Version 2)
listSpecificCollaboratorDetails 1 param → 200

Schemas 47

The contract defines 47 schemas that model the data the API accepts and returns. The most detailed are CollaboratorSchema (20 properties), CollaboratorV2 (20 properties), DeductionResponse (19 properties), MemberClientForm1099Balances (13 properties). Each schema is shown below with its type and property counts.

CompanyLinks
object
5 properties
Form1099Correction
object
8 properties
87539cb97aa7616e350fc0d23c5a49177ea4c4a8bd00ec2a2cfd2a9a5c4e648a
object
8a9c6cb49482a98cdd603ff09858cdc3e5ef6ad9807c876c4161d925a96694a5
object
3 properties
DeductionResponse
object
19 properties 16 required
6a65bb5a9fe6d1135b7182baff68e9bc6612ee2c1ab942926fe2804c58663cf4
object
2 properties
MemberClientForm1099Balances
object
13 properties 8 required
ClientData
object
3 properties
CollaboratorV2
object
20 properties 18 required
b9789f45f8c8070ff38a64d80c2e4a8732ddaf329e46546474400d26f84c0f1c
object
2 properties
MemberClientFormW9Info
object
13 properties
MemberClientRequirementResponse
object
9 properties 4 required
RedactedMember
object
2 properties 1 required
UserRoles
object
2 properties 2 required
MemberClientWireAccount
object
4 properties 2 required
CollaboratorGroupResponse
object
7 properties 5 required
CollaboratorUpdateRequest
object
6 properties
26e8ea23ccb1e007e7d6560175c7e75c768dac34727b7fe1d834ca24b8221ef4
object
1 property
EligibilityRequirement
object
5 properties 3 required
CollaboratorV2FormW9Info
object
13 properties 6 required
ce853dbef33b2b91880690c84bc5314340c1301fd7b3503dd6ce79c844e2a481
object
8 properties
Form1099Events
object
8 properties
DocumentResponse
object
9 properties 7 required
DocumentFiles
object
2 properties
DeductionCreateRequest
object
9 properties 6 required
CompanyPerson
object
2 properties 1 required
Company
object
13 properties
DocumentEvents
object
2 properties
CollaboratorGroupRequirement
object
1 property
PostPaymentDeductionDisbursement
object
2 properties 2 required
CollaboratorForm1099BalancesUpdateRequest
object
6 properties
CollaboratorSchema
object
20 properties 14 required
LabelsDictionary
object
f6f2bd1a2fc7bad4e0d8f22345fc5f6699d096b7797b93575869c544a4fc5cef
object
2 properties
CollaboratorEvents
object
4 properties 3 required
RedactedUser
object
6 properties
CollaboratorGroupCreateRequest
object
4 properties 2 required
23d776fc12e56286a20f36065e4f942c43a28218a62eb2f211116c130deb74eb
object
4 properties
Collaboration
object
6 properties 2 required
Address
object
5 properties 4 required
CollaboratorCreateRequest
object
11 properties 1 required
90f96495b02c2509fff131505484d46479a91b7d23ed2b0f438ca117d0bccad7
object
2 properties
7996a6815c717c0e93865680b5cd47dec90314e97e4e7282bed7fc2f367bc051
object
1 property
DeductionUpdateRequest
object
7 properties
9e97e63e736df301658ebeeab7f4fe84f3aeaa73800d3e4863801a3eb026df4b
object
1 property
MemberData
object
3 properties
DeductionApplication
object
3 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

wingspan-collaborator-management-api-openapi.yml Raw ↑

Other APIs Wingspan publishes across the network.

Wingspan 1099 Operations API
Wingspan Banking Management API
Wingspan Bulk Operations API
Wingspan Client Management API
Wingspan Custom Field Management API
Wingspan Deprecated API
Wingspan Document Signing and Eligibility API
Wingspan Invoice Management API
Wingspan Merchant Category Codes API
Wingspan Payables Management API
Wingspan Payroll Settings API
Wingspan Reporting and Analytics API