Every API here is available over the APIs.io API and to AI agents over MCP.
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.curl "https://apis.io/api/v1/apis/workfront-records-api"curl "https://apis.io/api/v1/apis?limit=25"Discovery needs no key. Ratings and market analysis are Pro.
openapi: 3.2.0
info:
title: Workfront Records API
version: '1.0'
description: 'Operations tagged Records across 2 of this provider''s published API definitions: workfront-planning-v1-openapi.json, workfront-planning-v2-openapi.json. Each path carries the servers of the definition it was published in.'
servers:
- url: https://{customer-domain}/maestro/api
description: Workfront Planning Service Url
tags:
- name: Records
description: Record Controller
paths:
/v1/records/{id}:
get:
tags:
- Records
summary: Get Record
description: Retrieve a specific record by its ID along with optional attributes.
operationId: getRecord
parameters:
- name: id
in: path
description: ID of the record to be retrieved
required: true
schema:
type: string
- name: aliased
in: query
description: Flag to include alias support
required: false
schema:
type: boolean
- name: attributes
in: query
description: List of attributes to be included in the response
required: false
schema:
type: array
items:
type: string
default:
- '*'
example: ALL
responses:
'200':
description: OK
content:
'*/*':
schema:
$ref: '#/components/schemas/RecordDto'
put:
tags:
- Records
summary: Update Record
description: Update an existing record with the given ID and details.
operationId: updateRecord
parameters:
- name: id
in: path
description: ID of the record to be updated
required: true
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/RecordDto'
required: true
responses:
'200':
description: OK
content:
'*/*':
schema:
$ref: '#/components/schemas/RecordDto'
delete:
tags:
- Records
summary: Delete Record by ID
description: Delete a specific record by its ID.
operationId: deleteRecord
parameters:
- name: id
in: path
description: ID of the record to be deleted
required: true
schema:
type: string
responses:
'200':
description: OK
servers:
- url: https://{customer-domain}/maestro/api
description: Workfront Planning Service Url
/v1/records:
post:
tags:
- Records
summary: Create Record
description: Create a new record with the given details.
operationId: createRecord
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/RecordDto'
required: true
responses:
'200':
description: OK
content:
'*/*':
schema:
$ref: '#/components/schemas/RecordDto'
servers:
- url: https://{customer-domain}/maestro/api
description: Workfront Planning Service Url
/v1/records/search:
get:
tags:
- Records
summary: Search Records by field values
description: Search for records based on specific field values.
operationId: searchRecordsGet
parameters:
- name: recordTypeId
in: query
description: Id of the record type
required: false
schema:
type: string
- name: recordTypeAlias
in: query
description: Alias of the record type
required: false
schema:
type: string
- name: aliased
in: query
description: Flag to include alias support
required: false
schema:
type: boolean
- name: filters
in: query
description: Filters
required: false
schema:
type: string
- name: groupingFieldIds
in: query
description: Grouping field ids
required: false
schema:
type: array
items:
type: string
- name: offset
in: query
description: Offset
required: false
schema:
type: integer
format: int32
default: 0
- name: limit
in: query
description: Limit
required: false
schema:
type: integer
format: int32
default: 500
- name: rowOrderViewId
in: query
description: Row order view id
required: false
schema:
type: string
- name: attributes
in: query
description: List of attributes to be included in the response
required: false
schema:
type: array
items:
type: string
default:
- '*'
example: ALL
responses:
'200':
description: OK
content:
'*/*':
schema:
$ref: '#/components/schemas/GroupedRecordsDto'
post:
tags:
- Records
summary: Search Records by field values
description: Search for records based on specific field values.
operationId: searchRecordsPost
parameters:
- name: recordTypeAlias
in: query
description: Alias of the record type
required: false
schema:
type: string
- name: aliased
in: query
description: Flag to include alias support
required: false
schema:
type: boolean
- name: attributes
in: query
description: List of attributes to be included in the response
required: false
schema:
type: array
items:
type: string
default:
- '*'
example: ALL
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/RecordSearchDto'
required: true
responses:
'200':
description: OK
content:
'*/*':
schema:
$ref: '#/components/schemas/GroupedRecordsDto'
servers:
- url: https://{customer-domain}/maestro/api
description: Workfront Planning Service Url
/v2/records/{id}:
get:
tags:
- Records
summary: Get Record
description: Retrieve a record by its ID.
operationId: getRecord
parameters:
- name: id
in: path
description: ID of the record to be retrieved
required: true
schema:
type: string
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/RecordDto_2'
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/V2ProblemDetail'
'403':
description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/V2ProblemDetail'
'404':
description: Not Found
content:
application/json:
schema:
$ref: '#/components/schemas/V2ProblemDetail'
'500':
description: Internal Server Error
content:
application/json:
schema:
$ref: '#/components/schemas/V2ProblemDetail'
put:
tags:
- Records
summary: Update Record
description: Update an existing record using PUT (full replacement). All fields not provided in the request will be set to null.
operationId: updateRecord
parameters:
- name: id
in: path
description: ID of the record to be updated
required: true
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/RecordBaseDto'
required: true
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/RecordDto_2'
'400':
description: Bad Request (validation failure)
content:
application/json:
schema:
$ref: '#/components/schemas/V2ProblemDetail'
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/V2ProblemDetail'
'403':
description: Forbidden (RECORD_CONNECTION_LIMIT_EXCEEDED, HIERARCHY_RECORD_CONNECTION_LIMIT_EXCEEDED)
content:
application/json:
schema:
$ref: '#/components/schemas/V2ProblemDetail'
'404':
description: Not Found
content:
application/json:
schema:
$ref: '#/components/schemas/V2ProblemDetail'
'409':
description: Conflict (write conflict, retry)
content:
application/json:
schema:
$ref: '#/components/schemas/V2ProblemDetail'
'422':
description: Unprocessable Entity (back-reference conflict)
content:
application/json:
schema:
$ref: '#/components/schemas/V2ProblemDetail'
'500':
description: Internal Server Error
content:
application/json:
schema:
$ref: '#/components/schemas/V2ProblemDetail'
delete:
tags:
- Records
summary: Delete Record
description: Delete a record by its ID.
operationId: deleteRecord
parameters:
- name: id
in: path
description: ID of the record to be deleted
required: true
schema:
type: string
responses:
'204':
description: No Content
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/V2ProblemDetail'
'403':
description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/V2ProblemDetail'
'404':
description: Not Found
content:
application/json:
schema:
$ref: '#/components/schemas/V2ProblemDetail'
'500':
description: Internal Server Error
content:
application/json:
schema:
$ref: '#/components/schemas/V2ProblemDetail'
patch:
tags:
- Records
summary: Patch Record
description: 'Partially update an existing record using PATCH (merge-patch semantics). Only provided fields will be updated; omitted fields remain unchanged. Setting a field value to JSON null (e.g. {"data":{"F123":null}}) explicitly clears that field; omitting the key leaves the field untouched. For list-type fields (connections, multi-select), you can use operational updates: [{"op": "add", "value": [...]}, {"op": "remove", "value": [...]}].'
operationId: patchRecord
parameters:
- name: id
in: path
description: ID of the record to be patched
required: true
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/RecordBaseDto'
required: true
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/RecordDto_2'
'400':
description: Bad Request (validation failure)
content:
application/json:
schema:
$ref: '#/components/schemas/V2ProblemDetail'
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/V2ProblemDetail'
'403':
description: Forbidden (RECORD_CONNECTION_LIMIT_EXCEEDED, HIERARCHY_RECORD_CONNECTION_LIMIT_EXCEEDED)
content:
application/json:
schema:
$ref: '#/components/schemas/V2ProblemDetail'
'404':
description: Not Found
content:
application/json:
schema:
$ref: '#/components/schemas/V2ProblemDetail'
'409':
description: Conflict (write conflict, retry)
content:
application/json:
schema:
$ref: '#/components/schemas/V2ProblemDetail'
'422':
description: Unprocessable Entity (back-reference conflict)
content:
application/json:
schema:
$ref: '#/components/schemas/V2ProblemDetail'
'500':
description: Internal Server Error
content:
application/json:
schema:
$ref: '#/components/schemas/V2ProblemDetail'
servers:
- url: https://{customer-domain}/maestro/api
description: Workfront Planning Service Url
/v2/record-types/{recordTypeId}/records/bulk:
put:
tags:
- Records
summary: Bulk Update Records
description: Update multiple records using PUT semantics (full replacement). All fields not provided will be set to null. Each record must include an id. Limited to 100 records per request.
operationId: bulkUpdateRecords
parameters:
- name: recordTypeId
in: path
description: ID of the record type
required: true
schema:
type: string
- name: aliased
in: query
description: Flag to include alias support in response (field keys will be aliases instead of IDs)
required: false
schema:
type: boolean
default: false
requestBody:
content:
application/json:
schema:
type: array
description: List of records to update. Each must include an id (max 100).
items:
$ref: '#/components/schemas/RecordBaseDto'
required: true
responses:
'200':
description: All items updated successfully
content:
application/json:
schema:
$ref: '#/components/schemas/RecordBulkResponseDto'
'207':
description: Mixed results — some items succeeded, some failed
content:
application/json:
schema:
$ref: '#/components/schemas/RecordBulkResponseDto'
'400':
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/V2ProblemDetail'
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/V2ProblemDetail'
'403':
description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/V2ProblemDetail'
'404':
description: Record Type Not Found
content:
application/json:
schema:
$ref: '#/components/schemas/V2ProblemDetail'
'409':
description: Conflict (write conflict, retry)
content:
application/json:
schema:
$ref: '#/components/schemas/V2ProblemDetail'
'500':
description: Internal Server Error
content:
application/json:
schema:
$ref: '#/components/schemas/V2ProblemDetail'
post:
tags:
- Records
summary: Bulk Create Records
description: Create multiple records in a record type in a single request. Limited to 100 records per request.
operationId: bulkCreateRecords
parameters:
- name: recordTypeId
in: path
description: ID of the record type
required: true
schema:
type: string
- name: aliased
in: query
description: Flag to include alias support in response (field keys will be aliases instead of IDs)
required: false
schema:
type: boolean
default: false
requestBody:
content:
application/json:
schema:
type: array
description: List of records to create (max 100)
items:
$ref: '#/components/schemas/RecordBaseDto'
required: true
responses:
'201':
description: All items created successfully
content:
application/json:
schema:
$ref: '#/components/schemas/RecordBulkResponseDto'
'207':
description: Mixed results — some items succeeded, some failed
content:
application/json:
schema:
$ref: '#/components/schemas/RecordBulkResponseDto'
'400':
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/V2ProblemDetail'
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/V2ProblemDetail'
'403':
description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/V2ProblemDetail'
'404':
description: Record Type Not Found
content:
application/json:
schema:
$ref: '#/components/schemas/V2ProblemDetail'
'500':
description: Internal Server Error
content:
application/json:
schema:
$ref: '#/components/schemas/V2ProblemDetail'
delete:
tags:
- Records
summary: Bulk Delete Records
description: Delete multiple records by their IDs in a single request. Limited to 100 records per request.
operationId: bulkDeleteRecords
parameters:
- name: recordTypeId
in: path
description: ID of the record type
required: true
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/BulkDeleteRequestDto'
required: true
responses:
'200':
description: All items deleted successfully
content:
application/json:
schema:
$ref: '#/components/schemas/RecordBulkResponseDto'
'207':
description: Mixed results — some items succeeded, some failed
content:
application/json:
schema:
$ref: '#/components/schemas/RecordBulkResponseDto'
'400':
description: Bad Request (empty ids list)
content:
application/json:
schema:
$ref: '#/components/schemas/V2ProblemDetail'
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/V2ProblemDetail'
'403':
description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/V2ProblemDetail'
'404':
description: Record Type Not Found
content:
application/json:
schema:
$ref: '#/components/schemas/V2ProblemDetail'
'500':
description: Internal Server Error
content:
application/json:
schema:
$ref: '#/components/schemas/V2ProblemDetail'
patch:
tags:
- Records
summary: Bulk Patch Records
description: Partially update multiple records using PATCH semantics (merge-patch). Only provided fields are updated; omitted fields remain unchanged. Each record must include an id. Limited to 100 records per request.
operationId: bulkPatchRecords
parameters:
- name: recordTypeId
in: path
description: ID of the record type
required: true
schema:
type: string
- name: aliased
in: query
description: Flag to include alias support in response (field keys will be aliases instead of IDs)
required: false
schema:
type: boolean
default: false
requestBody:
content:
application/json:
schema:
type: array
description: List of partial record updates. Each must include an id (max 100).
items:
$ref: '#/components/schemas/RecordBaseDto'
required: true
responses:
'200':
description: All items patched successfully
content:
application/json:
schema:
$ref: '#/components/schemas/RecordBulkResponseDto'
'207':
description: Mixed results — some items succeeded, some failed
content:
application/json:
schema:
$ref: '#/components/schemas/RecordBulkResponseDto'
'400':
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/V2ProblemDetail'
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/V2ProblemDetail'
'403':
description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/V2ProblemDetail'
'404':
description: Record Type Not Found
content:
application/json:
schema:
$ref: '#/components/schemas/V2ProblemDetail'
'409':
description: Conflict (write conflict, retry)
content:
application/json:
schema:
$ref: '#/components/schemas/V2ProblemDetail'
'500':
description: Internal Server Error
content:
application/json:
schema:
$ref: '#/components/schemas/V2ProblemDetail'
servers:
- url: https://{customer-domain}/maestro/api
description: Workfront Planning Service Url
/v2/records/{id}/thumbnail:
post:
tags:
- Records
summary: Upload thumbnail on record
description: Replace the record's thumbnail with the uploaded image. Each successful upload produces a new URL, even for identical content.
operationId: uploadThumbnail
parameters:
- name: id
in: path
description: ID of the record
required: true
schema:
type: string
requestBody:
content:
multipart/form-data:
schema:
type: object
properties:
file:
type: string
format: binary
description: PNG or JPEG image file
required:
- file
responses:
'201':
description: Thumbnail uploaded
content:
application/json:
schema:
$ref: '#/components/schemas/RecordDto_2'
'400':
description: Invalid image (THUMBNAIL_EMPTY, THUMBNAIL_INVALID_FORMAT, THUMBNAIL_INVALID_CONTENT, THUMBNAIL_SIZE_EXCEEDED)
content:
application/json:
schema:
$ref: '#/components/schemas/V2ProblemDetail'
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/V2ProblemDetail'
'403':
description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/V2ProblemDetail'
'404':
description: Record not found
content:
application/json:
schema:
$ref: '#/components/schemas/V2ProblemDetail'
'413':
description: Upload too large (UPLOAD_SIZE_EXCEEDED)
content:
application/json:
schema:
$ref: '#/components/schemas/V2ProblemDetail'
'500':
description: Internal Server Error
content:
application/json:
schema:
$ref: '#/components/schemas/V2ProblemDetail'
delete:
tags:
- Records
summary: Delete thumbnail on record
description: Remove the record's thumbnail. Idempotent — succeeds with 204 even when no thumbnail is set.
operationId: deleteThumbnail
parameters:
- name: id
in: path
description: ID of the record
required: true
schema:
type: string
responses:
'204':
description: Thumbnail removed
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/V2ProblemDetail'
'403':
description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/V2ProblemDetail'
'404':
description: Record not found
content:
application/json:
schema:
$ref: '#/components/schemas/V2ProblemDetail'
'500':
description: Internal Server Error
content:
application/json:
schema:
$ref: '#/components/schemas/V2ProblemDetail'
servers:
- url: https://{customer-domain}/maestro/api
description: Workfront Planning Service Url
/v2/record-types/{recordTypeId}/records:
get:
tags:
- Records
summary: Get Records by Record Type
description: Retrieve a page-based paginated list of records for a specific record type. Uses standard page/size query parameters (default page=0, size=20, sorted by createdAt).
operationId: getRecordsByRecordType
parameters:
- name: recordTypeId
in: path
description: ID of the record type
required: true
schema:
type: string
- name: page
in: query
description: Zero-based page index (0..N)
required: false
schema:
type: integer
default: 0
minimum: 0
- name: size
in: query
description: The size of the page to be returned
required: false
schema:
type: integer
default: 20
minimum: 1
- name: sort
in: query
description: 'Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.'
required: false
schema:
type: array
default:
- createdAt,ASC
items:
type: string
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/PageRecordDto'
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/V2ProblemDetail'
'403':
description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/V2ProblemDetail'
'404':
description: Record Type Not Found
content:
application/json:
schema:
$ref: '#/components/schemas/V2ProblemDetail'
'500':
description: Internal Server Error
content:
application/json:
schema:
$ref: '#/components/schemas/V2ProblemDetail'
post:
tags:
- Records
summary: Create Record
description: 'Create a new record in a record type. Subject to limits: max 25,000 records per record type.'
operationId: createRecord
parameters:
- name: recordTypeId
in: path
description: ID of the record type
required: true
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/RecordBaseDto'
required: true
responses:
'201':
description: Created
content:
application/json:
schema:
$ref: '#/components/schemas/RecordDto_2'
'400':
description: Bad Request (validation failure)
content:
application/json:
schema:
$ref: '#/components/schemas/V2ProblemDetail'
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/V2ProblemDetail'
'403':
description: Forbidden (RECORD_TYPE_RECORD_LIMIT_EXCEEDED)
content:
application/json:
schema:
$ref: '#/components/schemas/V2ProblemDetail'
'404':
description: Record Type Not Found
content:
application/json:
schema:
$ref: '#/components/schemas/V2ProblemDetail'
'422':
description: Unprocessable Entity (back-reference conflict)
content:
application/json:
schema:
$ref: '#/components/schemas/V2ProblemDetail'
'500':
description: Internal Server Error
content:
application/json:
schema:
$ref: '#/components/schemas/V2ProblemDetail'
servers:
- url: https://{customer-domain}/maestro/api
description: Workfront Planning Service Url
/v2/record-types/{recordTypeId}/records/search:
get:
tags:
- Records
summary: Search Records (GET)
description: Search records using query parameters. Accepts a JSON filter string using the composite filter pattern, field projection, and alias-based field access. Returns page-based paginated records along with group information.
operationId: searchRecordsGet
parameters:
- name: recordTypeId
in: path
description: ID of the record type
required: true
schema:
type: string
- name: recordTypeAlias
in: query
description: Alias of the record type
required: false
schema:
type: string
- name: aliased
in: query
description: Flag to include alias support in response (field keys will be aliases instead of IDs)
required: false
schema:
type: boolean
default: false
- name: filter
in: query
description: 'JSON filter using the composite filter pattern. Example: {"operator":"AND","conditions":[{"fieldId":"status","condition":"IS","value":"Active"}]}'
required: false
schema:
type: string
- name: groupingFieldIds
in: query
description: List of field IDs to group results by
required: false
schema:
type: array
items:
type: string
example: F693ab1c96f11ea3f4175e000,F693ab1c96f11ea3f4175e001
- name: scopeWorkspaceIds
in: query
description: List of workspace IDs to scope the search to (for global record types)
required: false
schema:
type: array
items:
type: string
example:
# --- truncated at 32 KB (71 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/workfront/refs/heads/main/openapi/workfront-records-api-openapi.yml