CoworkerContracts
Get multiple CoworkerContracts
Retrieve multiple CoworkerContract records by their Ids in a single request.
GET
/
api
/
billing
/
coworkercontracts
/
?id=[
{id1}
,
{id2}
,
{id3}
]
Get multiple CoworkerContracts
curl --request GET \
--url 'https://spaces.nexudus.com/api/billing/coworkercontracts/?id=%5B{id1}%2C{id2}%2C{id3}%5D' \
--header 'Authorization: Basic <encoded-value>'import requests
url = "https://spaces.nexudus.com/api/billing/coworkercontracts/?id=%5B{id1}%2C{id2}%2C{id3}%5D"
headers = {"Authorization": "Basic <encoded-value>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Basic <encoded-value>'}};
fetch('https://spaces.nexudus.com/api/billing/coworkercontracts/?id=%5B{id1}%2C{id2}%2C{id3}%5D', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));Fetch several CoworkerContract records in a single request by passing their Ids as a comma-separated list enclosed in square brackets.
Authentication
This endpoint requires OAuth2 authentication. Include a valid bearer token in the
Authorization header.
The authenticated user must be a full unrestricted administrator or have the CoworkerContract-Read role.Query Parameters
integer[]
required
A comma-separated list of CoworkerContract Ids enclosed in square brackets, e.g.
[123,456,789].Code Examples
curl -X GET \
"https://spaces.nexudus.com/api/billing/coworkercontracts/?id=[87654321,87654322,87654323]" \
-H "Authorization: Bearer YOUR_TOKEN"
const response = await fetch(
'https://spaces.nexudus.com/api/billing/coworkercontracts/?id=[87654321,87654322,87654323]',
{
headers: {
'Authorization': 'Bearer YOUR_TOKEN'
}
}
);
const records = await response.json();
import requests
response = requests.get(
'https://spaces.nexudus.com/api/billing/coworkercontracts/',
params={
'id': '[87654321,87654322,87654323]'
},
headers={
'Authorization': 'Bearer YOUR_TOKEN'
}
)
records = response.json()
Response
200
Returns an array of CoworkerContract records. Each record has the same structure as the response from the Get one CoworkerContract endpoint.Partial records — This endpoint returns a summary representation of each CoworkerContract. The following fields are not populated in the response:
Notes, PurchaseOrder, CancellationNotes, DeliveryInstructions, PoBoxNumber.To get all fields, fetch the full record using the Get one CoworkerContract endpoint.Important for updates: When updating a record via PUT, always retrieve the full record with a GET request first, apply your changes to that complete data, and then send the updated record. Do not use data from this endpoint as the base for a PUT request, as missing fields may be unintentionally cleared.Example Response
[
{
"IssuedById": 0,
"IssuedByName": null,
"CoworkerId": 0,
"CoworkerCoworkerType": null,
"CoworkerFullName": null,
"CoworkerCompanyName": null,
"CoworkerBillingName": null,
"CoworkerEmail": null,
"CoworkerActive": null,
"TariffId": 0,
"TariffName": null,
"TariffInvoiceEvery": null,
"TariffInvoiceEveryWeeks": null,
"TariffPrice": 0,
"TariffCurrencyCode": null,
"NextTariffId": null,
"NextTariffName": null,
"StartDate": null,
"BillingDay": 0,
"RenewalDate": null,
"InvoicedPeriod": null,
"ContractTerm": null,
"Price": null,
"Value": null,
"Desks": [],
"Variants": [],
"Quantity": 0,
"Active": false,
"MainContract": false,
"Cancelled": false,
"IncludeSignupFee": false,
"InvoiceAdvancedCycles": false,
"ApplyProRating": false,
"NextAutoInvoice": null,
"PricePlanTermsAccepted": false,
"PricePlanTermsAcceptedOn": null,
"CancellationDate": null,
"CancellationLimitDays": null,
"ProRateCancellation": false,
"CancelTeamContracts": false,
"CancellationReason": 0,
"DeliveryHandlingPreferenceChecks": 0,
"DeliveryHandlingPreferenceMail": 0,
"DeliveryHandlingPreferenceParcels": 0,
"DeliveryHandlingPreferencePublicity": 0,
"IdentityChecksDueOn": null,
"AddressChecksDueOn": null,
"StartDateLocal": null,
"RenewalDateLocal": null,
"NextAutoInvoiceLocal": null,
"PricePlanTermsAcceptedOnLocal": null,
"CancellationDateLocal": null,
"ContractTermLocal": null,
"ProposalUniqueId": null,
"ProposalContractUniqueId": null,
"CourseMemberUniqueId": null,
"InvoicedPeriodLocal": null,
"FloorPlanDeskIds": null,
"FloorPlanDeskNames": null,
"FloorPlanDeskVariantIds": null,
"FloorPlanDeskVariantNames": null,
"PriceWithProductsAndDeposits": 0,
"PriceWithProducts": 0,
"InPausedPeriod": false,
"InPausedPeriodFrom": null,
"InPausedPeriodUntil": null,
"Id": 87654321,
"UpdatedOn": "2025-01-15T10:30:00Z",
"CreatedOn": "2025-01-10T08:00:00Z",
"UniqueId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"UpdatedBy": "admin@example.com",
"IsNew": false,
"SystemId": null,
"ToStringText": "CoworkerContract Example",
"LocalizationDetails": null,
"CustomFields": null
}
]
Was this page helpful?
⌘I
Get multiple CoworkerContracts
curl --request GET \
--url 'https://spaces.nexudus.com/api/billing/coworkercontracts/?id=%5B{id1}%2C{id2}%2C{id3}%5D' \
--header 'Authorization: Basic <encoded-value>'import requests
url = "https://spaces.nexudus.com/api/billing/coworkercontracts/?id=%5B{id1}%2C{id2}%2C{id3}%5D"
headers = {"Authorization": "Basic <encoded-value>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Basic <encoded-value>'}};
fetch('https://spaces.nexudus.com/api/billing/coworkercontracts/?id=%5B{id1}%2C{id2}%2C{id3}%5D', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));