Skip to main content
New to Corsair? See API access, authentication, and error handling.

Account

status

account.status The site’s plan limits and usage: gage and user counts, gages due and past due, and what the client may change Risk: read
Input: empty object Output

Calibrations

certificate

calibrations.certificate Render a calibration certificate PDF for a record, returned base64-encoded with its content type Risk: read
Input Returns the PDF base64-encoded in certificate, with encoding, contentType and byteLength. Output

create

calibrations.create Record a calibration against a gage, with the readings, standard used and next due date Risk: write
Input
Output

delete

calibrations.delete Delete a calibration record Risk: destructive · Irreversible
Input Output

get

calibrations.get One calibration record with its as-found and as-left readings Risk: read
Input Output

list

calibrations.list Calibration records, paged; each names the gage it was run on through EquipmentRefId Risk: read
Input Output

update

calibrations.update Update a calibration record Risk: write
Input The body is the whole record with its Id, not a partial patch: read it with calibrations.get and send it back with your change.
Output

Custom Fields

list

customFields.list The account’s custom fields: each Id is the FieldId a value write takes, and ForType says whether it belongs on gages or calibrations Risk: read
Input: empty object Output

updateValues

customFields.updateValues Create or update custom field values on a gage or a calibration. RefType is 1 for a gage and 2 for a calibration Risk: write
Input Posts a bare JSON array. RefType is 1 for a gage and 2 for a calibration.
Output

Gages

create

gages.create Add a gage, with its serial and control numbers, calibration interval and responsible user Risk: write
Input Field names are PascalCase and bind case-sensitively. GageList spells the acquisition date DateAquired.
Output

delete

gages.delete Delete a gage. GageList marks it deleted rather than erasing it, but it stops appearing in the active list Risk: destructive · Irreversible
Input Output

get

gages.get One gage with its calibration dates, interval and assigned user Risk: read
Input Output

list

gages.list Gages on the site, paged by start and record_number in the request body; next_start gives the next page Risk: read
Input Pages by start and record_number in the request body. next_start is null on the last page. Output

update

gages.update Update a gage. The body is the whole record with its Id, not a partial patch Risk: write
Input The body is the whole record with its Id, not a partial patch: read it with gages.get and send it back with your change.
Output

Manufacturers

create

manufacturers.create Add a manufacturer with its address and contact details Risk: write
Input Output

delete

manufacturers.delete Delete a manufacturer Risk: destructive · Irreversible
Input Output

list

manufacturers.list Instrument manufacturers, paged Risk: read
Input Output

update

manufacturers.update Update a manufacturer Risk: write
Input Output