Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we
store it to create your key and to recognise you if you sign in with another
provider. See our Privacy Policy and
Terms.
openapi: 3.2.0
info:
title: Fieldstub Projects API
version: 1.0.0
summary: Capture extra work in the field and file it into Procore as a Change Event.
description: 'Fieldstub captures out-of-scope construction work from people who do not have a Procore seat, and writes it into Procore as a Change Event with typed line items on real budget codes.
Two things to understand before you build against this:
1. **Creating a ticket is safe. Approving one is not.** A ticket is a record of a claim. Approving writes money into a customer''s financials, and it is not reversible from here. Do not approve unattended.
2. **Check `routing` before you approve.** Procore accepts a line item with a blank budget code without warning, which is how costs go missing. Every line with `needs_review: true` should be seen by a human, and `allow_unrouted` exists so that choice has to be made explicitly.'
contact:
name: Fieldstub
email: hello@fieldstub.com
url: https://fieldstub.com
servers:
- url: https://app.fieldstub.com/v1
security:
- bearerAuth: []
tags:
- name: Projects
description: Procore projects and their budget codes.
paths:
/me:
get:
operationId: getMe
summary: Which company this key belongs to
tags:
- Projects
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
/projects:
get:
operationId: listProjects
summary: List Procore projects for this company
tags:
- Projects
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
/projects/{project_id}/cost-codes:
get:
operationId: searchCostCodes
summary: Search the project cost codes
tags:
- Projects
parameters:
- name: project_id
in: path
required: true
schema:
type: string
- name: q
in: query
required: false
description: Case-insensitive substring match.
schema:
type: string
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
'404':
description: Error
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
/projects/{project_id}/budget-codes:
post:
operationId: createBudgetCode
summary: Create a budget code the project does not have yet
description: Extra work is unplanned by definition, so the code a ticket needs is routinely not in the budget. This creates the WBS code so a line can be routed to it.
tags:
- Projects
parameters:
- name: project_id
in: path
required: true
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- cost_code_item_id
properties:
cost_code_item_id:
type: integer
cost_type:
type: string
enum:
- labor
- materials
- equipment
- other
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
'404':
description: Error
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
/projects/{project_id}/capability:
get:
operationId: projectCapability
summary: Where a ticket on this project can be filed
description: 'Whether the project can take a Change Event, which is really whether the company has Project Financials on it. Read from Procore rather than assumed: a project without the tool answers 403 or 404 while its other tools answer normally. Cached briefly, because licensing does not change per request.'
tags:
- Projects
parameters:
- name: project_id
in: path
required: true
schema:
type: string
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
properties:
change_events:
type: boolean
description: The project has the Change Events tool, so a change event can be written.
daily_log:
type: boolean
description: The project can take a daily log entry. True everywhere so far.
destination:
type: string
enum:
- change_event
- daily_log
description: What approve will do if you name nothing.
'404':
description: Error
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
components:
schemas:
Error:
type: object
properties:
error:
type: object
properties:
code:
type: string
description: Stable machine-readable code.
message:
type: string
details: {}
securitySchemes:
bearerAuth:
type: http
scheme: bearer
description: 'An API key from the review queue at /keys. Send as Authorization: Bearer fs_live_…'