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 Links 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: Links
description: Capture links. The link is the credential for the field.
paths:
/links:
get:
operationId: listLinks
summary: List capture links
tags:
- Links
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
post:
operationId: createLink
summary: Create a capture link
description: Returns a URL anyone can open with no account. Print it as a QR code and tape it in the gang box. Treat the token as a credential.
tags:
- Links
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- project_id
properties:
project_id:
type: string
label:
type: string
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
'404':
description: Error
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
/links/{token}/revoke:
post:
operationId: revokeLink
summary: Revoke a capture link
description: A taped-up QR code outlives the job. This is how it stops working.
tags:
- Links
parameters:
- name: token
in: path
required: true
schema:
type: string
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
'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_…'