OpenAPI Specification
openapi: 3.1.0
info:
title: Coordinate REST Comments Users API
version: v1
description: 'The Coordinate REST API lets you add, update, and retrieve the entities that make up Coordinate''s client project-execution platform: projects, project pages, tasks, task groups, stakeholders, goals, progress reports, discussion entries (comments), and organizations. All requests are scoped to the vendor that owns the API key; `vendor_id` is derived from the key and cannot be overridden. A companion webhook API lets external systems subscribe to create/update events. This description is captured by the API Evangelist enrichment pipeline from Coordinate''s published agent-oriented API reference.'
contact:
name: Coordinate Support
email: support@coordinatehq.com
url: https://www.coordinatehq.com/library/integrating-with-coordinate
termsOfService: https://coordinatehq.com/legal/terms-and-conditions
x-api-reference: https://app.coordinatehq.com/static/API_Documentation.html
servers:
- url: https://app.coordinatehq.com/api/v1
description: Production
security:
- BearerHeader: []
tags:
- name: Users
description: Vendor users.
paths:
/list_users:
get:
operationId: listUsers
summary: List vendor users
description: Returns all users in the vendor. Use to discover valid manager_email_address values.
tags:
- Users
responses:
'200':
description: Array of users
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/User'
'401':
$ref: '#/components/responses/Unauthorized'
components:
schemas:
User:
type: object
properties:
user_id:
type: string
format: uuid
email:
type: string
full_name:
type: string
additionalProperties: true
responses:
Unauthorized:
description: Missing or invalid API key
securitySchemes:
BearerHeader:
type: apiKey
in: header
name: Bearer
description: 'API key sent in a custom `Bearer:` header (note: this is a header named "Bearer", not the standard `Authorization: Bearer` scheme). Create keys in the Coordinate UI under Settings > Integrations > API Keys. The key scopes all requests to its owning vendor.'