Skip to main content
llms.txt
API v2 Updated 07 Nov 2026 3 min read

Coworkies API: start here

Connect your tools to API v2 with a scoped key, make your first read request and find job and directory integration guides.

Use the Coworkies API to read job listings and directory data or create jobs from your own tools. The base URL is https://api.coworkies.com/v2. Responses are JSON.

API v1 retirement

API v2 is the only active API. Explicit v1 version selectors and the website’s retired aliases return HTTP 410 with error code api_version_retired. Removed paths on the API hostname return HTTP 404. They are not redirected to v2.

Update older integrations to https://api.coworkies.com/v2, send the key in X-API-Key or Authorization: Bearer, and use the current endpoint parameters and response format. Changing only the version number is not sufficient. The existing index-api.php?version=v2&endpoint=... alias remains supported for configured clients, including Slack. The MCP service and Slack integration use API v2; v1 retirement does not change their consent or permissions. See current integration availability for supported clients.

1. Get the right API key

Open User settings → API tokens, choose a confirmed Pro space you manage and create a token. Space Admin’s API access shows team credentials. Create and manage API tokens.

Choose the smallest permissions your integration needs. A space key limits supported space-specific data and job operations to that space. It is not a way to gain access to other spaces. City lookups and public content are not all filtered by space; read each endpoint’s behavior.

2. Make a read request

Set COWORKIES_API_KEY in your server’s environment or secret store, then run:

curl --fail-with-body --max-time 30   'https://api.coworkies.com/v2/jobs'   -H "X-API-Key: ${COWORKIES_API_KEY}"

Check the HTTP status and success field. Job results are in data.jobs. An empty list can mean your space has no active jobs.

{
  "success": true,
  "status": 200,
  "data": { "jobs": [], "pagination": { "total": 0, "current_page": 1, "has_next": false, "next": null } }
}

This sample shows selected fields. Follow data.pagination.next to retrieve subsequent pages. See Jobs API.

3. Choose your integration guide

Full developer resources

ResourceUse
API referenceFull endpoint examples and request/response fields.
Swagger UIInteractive reference; write requests can change real data.
OpenAPI specificationImport into API tools or generate a client.
Concise LLM referenceShort integration context.
Full LLM referenceDetailed integration reference.

Most data endpoints require a key. Public routes include API information, feedback, newsletter subscription, blog content and Vine feeds. Health, Jobs, Cities, Spaces and Events require authentication. Keep keys in server-side integrations; do not include them in public frontend code.

Slack and MCP

For account connection, setup choices and space permissions, see Slack and MCP integrations. REST key permissions do not automatically grant private MCP access.

Guides in this section

Select a guide below to continue