Authorization
AuthorizationBearerrequired
Organisation API key supplied only through the Authorization header. Required scopes: companies:read.
Query parameters
matchingJobsobjectoptional
Explicit facts that must match one published job at the company. Action and target selections match one assertion.
agencyPoliciesenum[]optional
Maximum items:
50Available options:
Maximum items 50no_unsolicited_submissionsapproved_agencies_onlyagencies_invitedapplicationRoutesenum[]optional
Maximum items:
50Available options:
Maximum items 50luranta_hostedemployer_externalintermediary_externalbenefitsenum[]optional
Maximum items:
50Available options:
Maximum items 50health_insuranceretirement_planpaid_parental_leavepaid_time_offlearning_budgetrelocation_assistancecomplianceConceptsenum[]optional
Maximum items:
50Available options:
Maximum items 50iso_27001iso_9001soc_2pci_dssfedrampgdprhipaacomplianceRelationshipsenum[]optional
Maximum items:
50Available options:
Maximum items 50employer_claimregistry_recorddocument_verifiedjob_requirementplanned_workincludeUnstatedbooleanoptional
initiativeActionsenum[]optional
Maximum items:
50Available options:
Maximum items 50implement_systemmigrate_systemreplace_systemevaluate_vendorprepare_auditpursue_certificationinitiativeComplianceenum[]optional
Maximum items:
50Available options:
Maximum items 50iso_27001iso_9001soc_2pci_dssfedrampgdprhipaainitiativeToolsenum[]optional
Maximum items:
50Available options:
Maximum items 50ai-and-machine-learningbusiness-finance-and-erpcloud-infrastructure-and-securitycollaboration-and-productivitycreative-and-designdata-and-analyticsengineering-cad-and-geospatialhealthcare-and-laboratoryprogramming-languagessales-marketing-and-servicesoftware-delivery-and-testingsoftware-developmentdeveloper-tools-and-platformstypescriptjavascriptpythongorustcc-plus-plusc-sharpobjective-cjavakotlinswiftrubyphpscaladartelixirerlanghaskellluaperlrmatlabbashpowershellreactreact-nativenextjsnodejsangularvuejssvelteremixexpressnestjsdjangoflaskfastapiruby-on-railsspringlaraveldotnetasp-netflutterandroidiosreduxtailwind-csssqlpostgresqlmysqlmariadbsqliteoracle-databasemicrosoft-sql-servermongodbredisdynamodbcassandraelasticsearchopensearchbigqueryredshiftdbtairflowsparkflinkhadooptrinoclickhouseneo4jsupabasedatabrickssnowflakekafkapytorchtensorflownumpypandasscikit-learnjaxkerasxgboosthugging-facelangchainllamaindexmlflowcudaopenai-apianthropic-apiragcomputer-visionnlpllmsai-agentslinuxgitgithub-actionsgitlab-cijenkinscircleciargo-cdkuberneteshelmdockeransibleterraformpulumiopenshiftawsgcpazurecloudflarevercelnetlifyserverlessprometheusgrafanaopentelemetrydatadogsplunkgraphqlrestgrpcrabbitmqnatswebsocketsvitewebpackjestvitestcypressplaywrightseleniumstorybookexcelmicrosoft-powerpointmicrosoft-wordmicrosoft-outlookmicrosoft-teamsmicrosoft-sharepointgoogle-workspaceslacknotionjiraconfluenceadobe-photoshopadobe-illustratoradobe-indesignadobe-premiere-proadobe-after-effectsadobe-acrobatcanvafigmablenderautodesk-mayafinal-cut-proautocadautodesk-revitsolidworkscatiasiemens-nxautodesk-fusion-360sketchuparcgisqgisautodesk-civil-3dansyslabviewprocoreprimavera-p6tableaupower-bilookeralteryxsasibm-spssstataminitabsaporacle-erpnetsuitemicrosoft-dynamics-365workdayquickbooksxerosageservicenowbloomberg-terminalsalesforcehubspotmarketogoogle-adsmeta-adsgoogle-analyticszendeskepicoracle-healthmeditechveeva-vaultlimsziggleamjuliaclojuref-sharpocamlgroovyfortrancobolsolidityvhdlverilogassemblyabapapexcrystalnimvisual-basichtml5csssasslesspostcsshtmxjquerywebassemblydenobunastronuxtgatsbysolidjsqwikember-jsalpine-jslitelectrontauriioniccapacitorbootstrapmuiant-designchakra-uishadcn-uiradix-uibase-uithree-jsd3-jstanstackzustandzodrxjsprismadrizzle-ormsqlalchemyhibernateentity-frameworkmongoosesequelizeknex-jsphoenixsymfonycakephpcodeigniterfastifykoahonoadonisjsactixqtunityunreal-enginegodotexpojetpack-composeswiftuiopencvopenglvulkanwebrtcgithubgitlabbitbucketazure-devopsapache-mavengradlenpmpnpmyarnpippoetrycomposernugetcmakebazelnxturborepobabelrollupesbuildswcpostmaninsomniaswaggerpytestmochachaijasminecucumberk6apache-jmeterpactsonarqubesentryvisual-studio-codevisual-studiointellij-ideapycharmwebstormandroid-studioxcodeeclipsevimneovimmamptravis-citeamcitybuildkiteflux-cdtektonskaffoldgnu-makenixgithub-copilotcodexclaude-codeclaudeopencodeopenrouterollamamistral-aiqwengoogle-geminideepseekcursorwindsurfv0coheregroqvercel-ai-sdkcloudflare-workersfastlyalibaba-cloudapache-cloudstackapache-tomcatwp-enginedebianubuntured-hat-enterprise-linuxcentosrocky-linuxalpine-linuxfedoraarch-linuxwindows-serveroracle-cloudibm-clouddigitaloceanherokufly-iorenderrailwayfirebaseakamaiopenstackcloud-foundryvmwareproxmoxnomadconsulhashicorp-vaultpackeristioenvoynginxapache-http-servercaddytraefikhaproxyoktaauth0keycloaksnyktrivyowaspburp-suitewiresharkmetasploitpalo-alto-networksfortinetzscalercrowdstrikeciscojuniper-networksf5tailscalewireguardkibanalogstashgrafana-lokinew-relicdynatracepagerdutyopsgeniehoneycombplanetscalepolarsduckdbcockroachdbinfluxdbtimescaledbcouchdbcouchbasesinglestoretidbpineconeqdrantweaviatemilvustursoapache-hiveprestoapache-druidapache-beamapache-supersetmetabaseqlikjupyterrstudioplotlyscipymatplotlibapache-icebergfivetranairbytedagsterprefectapache-pulsaractivemqmqttlinearclickupworkplaceasanatrellomonday-comairtablemirozoomdropboxboxmicrosoft-onedrivebasecamptodoistloomsmartsheetshortcutmattermostwebexzapiern8nmake-comuipathmicrosoft-power-automatemicrosoft-power-appsmicrosoft-projectgoogle-search-consolegoogle-tag-managersemrushahrefsmailchimpklaviyobrazesegmentmixpanelamplitudehotjaroptimizelycontentfulsanitywordpresswebflowshopifywoocommercemagentobigcommerceintercomfreshdeskhootsuitepipedriveadobe-analyticsdrupaljoomlaghostsquarespacewixprestashopodoosap-successfactorsadp-workforce-nowukgdayforcebamboohrdocusignstripepaypalsquareanaplanworkivasketchframeradobe-xdadobe-lightroomadobe-auditiondavinci-resolveavid-media-composerpro-toolsaudacityableton-livefl-studiocinema-4daffinity-designeraffinity-photoinkscapegimpkritacoreldrawhoudinizbrushmapboxopenstreetmapgoogle-earthcartorhino-3darchicadautodesk-inventoraltium-designerkicadsimulinkrosbenchlinglabwarelistingRelationshipsenum[]optional
Maximum items:
50Available options:
Maximum items 50direct_employerrecruitment_intermediarynoDegreeRequiredenumoptional
Available options:
Constant truetruerecruitingPlatformsenum[]optional
Maximum items:
50Available options:
Maximum items 50adpashbyavaturedayforceeightfoldgreenhouseicimsjobviteleveroraclecloudpageuppersoniophenomrecruiteesuccessfactorssmartrecruiterstaleoteamtailorukgworkableworkdaytechnologyOperatorenumoptional
Available options:
anyalltechnologyRelationshipsenum[]optional
Maximum items:
50Available options:
Maximum items 50required_experiencepreferred_experienceexplicit_current_useplanned_introductionplanned_replacementtechnologyToolsenum[]optional
Maximum items:
50Available options:
Maximum items 50typescriptjavascriptpythongorustcc-plus-plusc-sharpobjective-cjavakotlinswiftrubyphpscaladartelixirerlanghaskellluaperlrmatlabbashpowershellreactreact-nativenextjsnodejsangularvuejssvelteremixexpressnestjsdjangoflaskfastapiruby-on-railsspringlaraveldotnetasp-netflutterandroidiosreduxtailwind-csssqlpostgresqlmysqlmariadbsqliteoracle-databasemicrosoft-sql-servermongodbredisdynamodbcassandraelasticsearchopensearchbigqueryredshiftdbtairflowsparkflinkhadooptrinoclickhouseneo4jsupabasedatabrickssnowflakekafkapytorchtensorflownumpypandasscikit-learnjaxkerasxgboosthugging-facelangchainllamaindexmlflowcudaopenai-apianthropic-apiragcomputer-visionnlpllmsai-agentslinuxgitgithub-actionsgitlab-cijenkinscircleciargo-cdkuberneteshelmdockeransibleterraformpulumiopenshiftawsgcpazurecloudflarevercelnetlifyserverlessprometheusgrafanaopentelemetrydatadogsplunkgraphqlrestgrpcrabbitmqnatswebsocketsvitewebpackjestvitestcypressplaywrightseleniumstorybookexcelmicrosoft-powerpointmicrosoft-wordmicrosoft-outlookmicrosoft-teamsmicrosoft-sharepointgoogle-workspaceslacknotionjiraconfluenceadobe-photoshopadobe-illustratoradobe-indesignadobe-premiere-proadobe-after-effectsadobe-acrobatcanvafigmablenderautodesk-mayafinal-cut-proautocadautodesk-revitsolidworkscatiasiemens-nxautodesk-fusion-360sketchuparcgisqgisautodesk-civil-3dansyslabviewprocoreprimavera-p6tableaupower-bilookeralteryxsasibm-spssstataminitabsaporacle-erpnetsuitemicrosoft-dynamics-365workdayquickbooksxerosageservicenowbloomberg-terminalsalesforcehubspotmarketogoogle-adsmeta-adsgoogle-analyticszendeskepicoracle-healthmeditechveeva-vaultlimsziggleamjuliaclojuref-sharpocamlgroovyfortrancobolsolidityvhdlverilogassemblyabapapexcrystalnimvisual-basichtml5csssasslesspostcsshtmxjquerywebassemblydenobunastronuxtgatsbysolidjsqwikember-jsalpine-jslitelectrontauriioniccapacitorbootstrapmuiant-designchakra-uishadcn-uiradix-uibase-uithree-jsd3-jstanstackzustandzodrxjsprismadrizzle-ormsqlalchemyhibernateentity-frameworkmongoosesequelizeknex-jsphoenixsymfonycakephpcodeigniterfastifykoahonoadonisjsactixqtunityunreal-enginegodotexpojetpack-composeswiftuiopencvopenglvulkanwebrtcgithubgitlabbitbucketazure-devopsapache-mavengradlenpmpnpmyarnpippoetrycomposernugetcmakebazelnxturborepobabelrollupesbuildswcpostmaninsomniaswaggerpytestmochachaijasminecucumberk6apache-jmeterpactsonarqubesentryvisual-studio-codevisual-studiointellij-ideapycharmwebstormandroid-studioxcodeeclipsevimneovimmamptravis-citeamcitybuildkiteflux-cdtektonskaffoldgnu-makenixgithub-copilotcodexclaude-codeclaudeopencodeopenrouterollamamistral-aiqwengoogle-geminideepseekcursorwindsurfv0coheregroqvercel-ai-sdkcloudflare-workersfastlyalibaba-cloudapache-cloudstackapache-tomcatwp-enginedebianubuntured-hat-enterprise-linuxcentosrocky-linuxalpine-linuxfedoraarch-linuxwindows-serveroracle-cloudibm-clouddigitaloceanherokufly-iorenderrailwayfirebaseakamaiopenstackcloud-foundryvmwareproxmoxnomadconsulhashicorp-vaultpackeristioenvoynginxapache-http-servercaddytraefikhaproxyoktaauth0keycloaksnyktrivyowaspburp-suitewiresharkmetasploitpalo-alto-networksfortinetzscalercrowdstrikeciscojuniper-networksf5tailscalewireguardkibanalogstashgrafana-lokinew-relicdynatracepagerdutyopsgeniehoneycombplanetscalepolarsduckdbcockroachdbinfluxdbtimescaledbcouchdbcouchbasesinglestoretidbpineconeqdrantweaviatemilvustursoapache-hiveprestoapache-druidapache-beamapache-supersetmetabaseqlikjupyterrstudioplotlyscipymatplotlibapache-icebergfivetranairbytedagsterprefectapache-pulsaractivemqmqttlinearclickupworkplaceasanatrellomonday-comairtablemirozoomdropboxboxmicrosoft-onedrivebasecamptodoistloomsmartsheetshortcutmattermostwebexzapiern8nmake-comuipathmicrosoft-power-automatemicrosoft-power-appsmicrosoft-projectgoogle-search-consolegoogle-tag-managersemrushahrefsmailchimpklaviyobrazesegmentmixpanelamplitudehotjaroptimizelycontentfulsanitywordpresswebflowshopifywoocommercemagentobigcommerceintercomfreshdeskhootsuitepipedriveadobe-analyticsdrupaljoomlaghostsquarespacewixprestashopodoosap-successfactorsadp-workforce-nowukgdayforcebamboohrdocusignstripepaypalsquareanaplanworkivasketchframeradobe-xdadobe-lightroomadobe-auditiondavinci-resolveavid-media-composerpro-toolsaudacityableton-livefl-studiocinema-4daffinity-designeraffinity-photoinkscapegimpkritacoreldrawhoudinizbrushmapboxopenstreetmapgoogle-earthcartorhino-3darchicadautodesk-inventoraltium-designerkicadsimulinkrosbenchlinglabwareworkingConditionsenum[]optional
Maximum items:
50Available options:
Maximum items 50on_callnight_workweekend_workshift_worktravel_requiredcompanyobjectoptional
Company context. Values within each category use OR; categories combine with AND. Employee bounds must contain the whole disclosed interval. FTE never satisfies an employee-count filter.
complianceConceptsenum[]optional
Maximum items:
7Available options:
Maximum items 7iso_27001iso_9001soc_2pci_dssfedrampgdprhipaacomplianceRelationshipsenum[]optional
Maximum items:
5Available options:
Maximum items 5employer_claimregistry_recorddocument_verifiedjob_requirementplanned_workemployeeSizeenumoptional
Available options:
01-1011-5051-200201-500501-10001001-50005001-1000010001-plusfinancingCurrencyenumoptional
Available options:
AEDAFNALLAMDAOAARSAUDAWGAZNBAMBBDBDTBHDBIFBMDBNDBOBBRLBSDBTNBWPBYNBZDCADCDFCHFCLPCNYCOPCRCCUPCVECZKDJFDKKDOPDZDEGPERNETBEURFJDFKPGBPGELGHSGIPGMDGNFGTQGYDHKDHNLHTGHUFIDRILSINRIQDIRRISKJMDJODJPYKESKGSKHRKMFKPWKRWKWDKYDKZTLAKLBPLKRLRDLSLLYDMADMDLMGAMKDMMKMNTMOPMRUMURMVRMWKMXNMYRMZNNADNGNNIONOKNPRNZDOMRPABPENPGKPHPPKRPLNPYGQARRONRSDRUBRWFSARSBDSCRSDGSEKSGDSHPSLESOSSRDSSPSTNSYPSZLTHBTJSTMTTNDTOPTRYTTDTWDTZSUAHUGXUSDUYUUZSVESVNDVUVWSTXAFXCDXCGXOFXPFYERZARZMWZWGBGNfinancingMaxnumberoptional
Range:
Maximum 1000000000000000Minimum 001000000000000000financingMeaningenumoptional
Available options:
round_raisedofferedsoldremainingvaluationreported_total_raisedfinancingMinnumberoptional
Range:
Maximum 1000000000000000Minimum 001000000000000000financingTypesenum[]optional
Maximum items:
5Available options:
Maximum items 5equitydebtconvertiblegrantmixedfundingStagesenum[]optional
Maximum items:
7Available options:
Maximum items 7angelpre_seedseedseries_aseries_bseries_cseries_d_plusincludeUnstatedbooleanoptional
kindsenum[]optional
Maximum items:
9Available options:
Maximum items 9companybrandgovernmenteducationhealthcarenonprofitpartnershipagencyotherownershipStatusesenum[]optional
Maximum items:
2Available options:
Maximum items 2publicly_tradedprivately_heldworkforceBasisenumoptional
Available options:
headcountannual_average_employeesquerystringoptional
Company-name query using case-insensitive substring and similarity matching. Normalized to Unicode NFC with folded whitespace; 1–200 characters.
Range:
Examples ["Acme"]Maximum length 200Minimum length 11200countriesenum[]optional
ISO 3166-1 alpha-2 country codes. Companies in any supplied country are returned.
Maximum items:
50Available options:
Default []Examples [["GB"]]Maximum items 50ADAEAFAGAIALAMAOAQARASATAUAWAXAZBABBBDBEBFBGBHBIBJBLBMBNBOBQBRBSBTBVBWBYBZCACCCDCFCGCHCICKCLCMCNCOCRCUCVCWCXCYCZDEDJDKDMDODZECEEEGEHERESETFIFJFKFMFOFRGAGBGDGEGFGGGHGIGLGMGNGPGQGRGSGTGUGWGYHKHMHNHRHTHUIDIEILIMINIOIQIRISITJEJMJOJPKEKGKHKIKMKNKPKRKWKYKZLALBLCLILKLRLSLTLULVLYMAMCMDMEMFMGMHMKMLMMMNMOMPMQMRMSMTMUMVMWMXMYMZNANCNENFNGNINLNONPNRNUNZOMPAPEPFPGPHPKPLPMPNPRPSPTPWPYQARERORSRURWSASBSCSDSESGSHSISJSKSLSMSNSOSRSSSTSVSXSYSZTCTDTFTGTHTJTKTLTMTNTOTRTTTVTWTZUAUGUMUSUYUZVAVCVEVGVIVNVUWFWSYEYTZAZMZWindustriesenum[]optional
Industry sector codes assigned to the company. Companies matching any supplied sector are returned.
Maximum items:
23Available options:
Default []Examples [["technology-information-services"]]Maximum items 23agriculture-forestry-fishingmining-natural-resourcesenergy-utilitiesenvironmental-waste-servicesmanufacturingfashion-textiles-apparelconsumer-goodsconstructionreal-estatewholesale-retailtransport-logistics-postalhospitality-food-travelmedia-arts-entertainmenttechnology-information-servicestelecommunicationsfinance-insuranceprofessional-business-serviceseducationhealthcare-life-sciencessocial-caregovernment-public-sectornonprofit-associationspersonal-household-servicessortenumoptional
Available options:
namerecencypaginationTokenstringoptional
Opaque keyset token from meta.nextToken or meta.previousToken. Reuse it with unchanged filters and sort. Expires after 24 hours.
Range:
Maximum length 1000Minimum length 111000Responses
A page of source-attributed observation bundles.
Pagination
metaobjectrequired
nextTokenstringrequirednullable
previousTokenstringrequirednullable
resultCountintegerrequired
Range:
Maximum 50Minimum 0050dataobject[]required
Maximum items:
Maximum items 5050companyIdstringrequired
Format:
uuidPattern:
Format uuidPattern ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-7[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-7[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$factsobject[]required
companyIdstringrequired
Format:
uuidPattern:
Format uuidPattern ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-7[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-7[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$evidenceobjectrequired
datesobjectrequired
observedAtstringrequired
Format:
date-timePattern:
Format date-timePattern ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$occurredOnstringrequirednullable
publishedOnstringrequirednullable
reportingPeriodobjectrequirednullable
endstringrequired
Format:
datePattern:
Format datePattern ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))$^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))$startstringrequired
Format:
datePattern:
Format datePattern ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))$^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))$digeststringrequired
Pattern:
Pattern ^[0-9a-f]{64}$^[0-9a-f]{64}$parserRevisionstringrequired
Pattern:
Pattern ^[0-9a-f]{64}$^[0-9a-f]{64}$referencestringrequired
Range:
Maximum length 1000Minimum length 111000sourceUrlstringrequired
Format:
uriMaximum length:
Format uriMaximum length 20482048factobjectrequired
asOfstringrequirednullable
basisenumrequired
Available options:
headcountannual_average_employeesfull_time_equivalentskindenumrequired
Available options:
Constant workforceworkforcereportingPeriodobjectrequirednullable
endstringrequired
Format:
datePattern:
Format datePattern ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))$^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))$startstringrequired
Format:
datePattern:
Format datePattern ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))$^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))$subjectScopeenumrequired
Available options:
hiring_organisationconsolidated_hiring_grouplegal_entitylocal_establishmentparent_organisationvalueobjectrequired
maxnumberrequirednullable
minnumberrequirednullable
amountsobject[]required
Maximum items:
Maximum items 2020currencyenumrequired
Available options:
AEDAFNALLAMDAOAARSAUDAWGAZNBAMBBDBDTBHDBIFBMDBNDBOBBRLBSDBTNBWPBYNBZDCADCDFCHFCLPCNYCOPCRCCUPCVECZKDJFDKKDOPDZDEGPERNETBEURFJDFKPGBPGELGHSGIPGMDGNFGTQGYDHKDHNLHTGHUFIDRILSINRIQDIRRISKJMDJODJPYKESKGSKHRKMFKPWKRWKWDKYDKZTLAKLBPLKRLRDLSLLYDMADMDLMGAMKDMMKMNTMOPMRUMURMVRMWKMXNMYRMZNNADNGNNIONOKNPRNZDOMRPABPENPGKPHPPKRPLNPYGQARRONRSDRUBRWFSARSBDSCRSDGSEKSGDSHPSLESOSSRDSSPSTNSYPSZLTHBTJSTMTTNDTOPTRYTTDTWDTZSUAHUGXUSDUYUUZSVESVNDVUVWSTXAFXCDXCGXOFXPFYERZARZMWZWGBGNmeaningenumrequired
Available options:
round_raisedofferedsoldremainingvaluationreported_total_raisedvaluenumberrequired
Range:
Maximum 1000000000000000Minimum 001000000000000000financingTypestringrequirednullable
Available options:
equitydebtconvertiblegrantmixedoccurredOnstringrequirednullable
stagestringrequirednullable
Available options:
angelpre_seedseedseries_aseries_bseries_cseries_d_plusappliesToenumrequired
Available options:
organisationproductservicefacilityjobconceptenumrequired
Available options:
iso_27001iso_9001soc_2pci_dssfedrampgdprhipaarelationshipenumrequired
Available options:
employer_claimregistry_recorddocument_verifiedjob_requirementplanned_worksoc2ReportTypestringrequirednullable
Available options:
type_itype_iivalidFromstringrequirednullable
validThroughstringrequirednullable
verificationUrlstringrequirednullable
Headers
Luranta-Cost-USDstringoptional
Credit consumed as a USD decimal string. Present only on successful billable responses.
Pattern:
Pattern ^(?:0|[1-9]\d*)\.\d{2,6}$^(?:0|[1-9]\d*)\.\d{2,6}$Luranta-Credit-Balance-USDstringoptional
Organisation credit remaining after settlement. Present only on successful billable responses.
Pattern:
Pattern ^(?:0|[1-9]\d*)\.\d{2,6}$^(?:0|[1-9]\d*)\.\d{2,6}$Luranta-Resources-Returnedintegeroptional
Number of resources returned and charged. Present only on successful billable responses.
Range:
Maximum 2147483647Minimum 002147483647traceparentstringrequired
W3C trace context generated for this request attempt.
Pattern:
Pattern ^00-[0-9a-f]{32}-[0-9a-f]{16}-[0-9a-f]{2}$^00-[0-9a-f]{32}-[0-9a-f]{16}-[0-9a-f]{2}$X-Request-Idstringrequired
Unique UUIDv7 identifier for this request attempt.
Format:
Format uuiduuidThe request contains an invalid parameter, parameter combination, or cursor.
This response uses Problem Details.
Identity
titlestringrequired
Range:
Maximum length 120Minimum length 11120typestringrequired
Format:
uriMaximum length:
Format uriMaximum length 20482048Errors
errorsobject[]required
Range:
Maximum items 100Minimum items 11100codestringrequired
Range:
Maximum length 80Minimum length 1180messagestringrequired
Range:
Maximum length 500Minimum length 11500pointerstringrequired
Format:
starts_withPattern:
Format starts_withPattern ^\/.*^\/.*availableCreditUsdstringoptional
Pattern:
Pattern ^(?:0|[1-9]\d*)\.\d{2,6}$^(?:0|[1-9]\d*)\.\d{2,6}$codestringrequired
Range:
Maximum length 80Minimum length 1180detailstringrequired
Range:
Maximum length 1000Minimum length 111000instancestringrequired
Format:
starts_withPattern:
Format starts_withPattern ^\/.*^\/.*paramstringoptional
Range:
Maximum length 160Minimum length 11160requestIdstringrequired
Format:
uuidPattern:
Format uuidPattern ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-7[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-7[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$requiredCreditUsdstringoptional
Pattern:
Pattern ^(?:0|[1-9]\d*)\.\d{2,6}$^(?:0|[1-9]\d*)\.\d{2,6}$retryablebooleanrequired
statusintegerrequired
Range:
Maximum 599Minimum 400400599topUpUrlstringoptional
Format:
uriMaximum length:
Format uriMaximum length 20482048Headers
traceparentstringrequired
W3C trace context generated for this request attempt.
Pattern:
Pattern ^00-[0-9a-f]{32}-[0-9a-f]{16}-[0-9a-f]{2}$^00-[0-9a-f]{32}-[0-9a-f]{16}-[0-9a-f]{2}$X-Request-Idstringrequired
Unique UUIDv7 identifier for this request attempt.
Format:
Format uuiduuidThe organisation API key is missing, invalid, expired, or revoked.
This response uses Problem Details.
Identity
titlestringrequired
Range:
Maximum length 120Minimum length 11120typestringrequired
Format:
uriMaximum length:
Format uriMaximum length 20482048Errors
errorsobject[]required
Range:
Maximum items 100Minimum items 11100codestringrequired
Range:
Maximum length 80Minimum length 1180messagestringrequired
Range:
Maximum length 500Minimum length 11500pointerstringrequired
Format:
starts_withPattern:
Format starts_withPattern ^\/.*^\/.*availableCreditUsdstringoptional
Pattern:
Pattern ^(?:0|[1-9]\d*)\.\d{2,6}$^(?:0|[1-9]\d*)\.\d{2,6}$codestringrequired
Range:
Maximum length 80Minimum length 1180detailstringrequired
Range:
Maximum length 1000Minimum length 111000instancestringrequired
Format:
starts_withPattern:
Format starts_withPattern ^\/.*^\/.*paramstringoptional
Range:
Maximum length 160Minimum length 11160requestIdstringrequired
Format:
uuidPattern:
Format uuidPattern ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-7[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-7[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$requiredCreditUsdstringoptional
Pattern:
Pattern ^(?:0|[1-9]\d*)\.\d{2,6}$^(?:0|[1-9]\d*)\.\d{2,6}$retryablebooleanrequired
statusintegerrequired
Range:
Maximum 599Minimum 400400599topUpUrlstringoptional
Format:
uriMaximum length:
Format uriMaximum length 20482048Headers
traceparentstringrequired
W3C trace context generated for this request attempt.
Pattern:
Pattern ^00-[0-9a-f]{32}-[0-9a-f]{16}-[0-9a-f]{2}$^00-[0-9a-f]{32}-[0-9a-f]{16}-[0-9a-f]{2}$X-Request-Idstringrequired
Unique UUIDv7 identifier for this request attempt.
Format:
Format uuiduuidThe organisation does not have enough credit to reserve this operation.
This response uses Problem Details.
Identity
titlestringrequired
Range:
Maximum length 120Minimum length 11120typestringrequired
Format:
uriMaximum length:
Format uriMaximum length 20482048Errors
errorsobject[]required
Range:
Maximum items 100Minimum items 11100codestringrequired
Range:
Maximum length 80Minimum length 1180messagestringrequired
Range:
Maximum length 500Minimum length 11500pointerstringrequired
Format:
starts_withPattern:
Format starts_withPattern ^\/.*^\/.*availableCreditUsdstringoptional
Pattern:
Pattern ^(?:0|[1-9]\d*)\.\d{2,6}$^(?:0|[1-9]\d*)\.\d{2,6}$codestringrequired
Range:
Maximum length 80Minimum length 1180detailstringrequired
Range:
Maximum length 1000Minimum length 111000instancestringrequired
Format:
starts_withPattern:
Format starts_withPattern ^\/.*^\/.*paramstringoptional
Range:
Maximum length 160Minimum length 11160requestIdstringrequired
Format:
uuidPattern:
Format uuidPattern ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-7[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-7[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$requiredCreditUsdstringoptional
Pattern:
Pattern ^(?:0|[1-9]\d*)\.\d{2,6}$^(?:0|[1-9]\d*)\.\d{2,6}$retryablebooleanrequired
statusintegerrequired
Range:
Maximum 599Minimum 400400599topUpUrlstringoptional
Format:
uriMaximum length:
Format uriMaximum length 20482048Headers
traceparentstringrequired
W3C trace context generated for this request attempt.
Pattern:
Pattern ^00-[0-9a-f]{32}-[0-9a-f]{16}-[0-9a-f]{2}$^00-[0-9a-f]{32}-[0-9a-f]{16}-[0-9a-f]{2}$X-Request-Idstringrequired
Unique UUIDv7 identifier for this request attempt.
Format:
Format uuiduuidThe authenticated organisation lacks the required scope, or the browser origin is not allowed.
This response uses Problem Details.
Identity
titlestringrequired
Range:
Maximum length 120Minimum length 11120typestringrequired
Format:
uriMaximum length:
Format uriMaximum length 20482048Errors
errorsobject[]required
Range:
Maximum items 100Minimum items 11100codestringrequired
Range:
Maximum length 80Minimum length 1180messagestringrequired
Range:
Maximum length 500Minimum length 11500pointerstringrequired
Format:
starts_withPattern:
Format starts_withPattern ^\/.*^\/.*availableCreditUsdstringoptional
Pattern:
Pattern ^(?:0|[1-9]\d*)\.\d{2,6}$^(?:0|[1-9]\d*)\.\d{2,6}$codestringrequired
Range:
Maximum length 80Minimum length 1180detailstringrequired
Range:
Maximum length 1000Minimum length 111000instancestringrequired
Format:
starts_withPattern:
Format starts_withPattern ^\/.*^\/.*paramstringoptional
Range:
Maximum length 160Minimum length 11160requestIdstringrequired
Format:
uuidPattern:
Format uuidPattern ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-7[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-7[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$requiredCreditUsdstringoptional
Pattern:
Pattern ^(?:0|[1-9]\d*)\.\d{2,6}$^(?:0|[1-9]\d*)\.\d{2,6}$retryablebooleanrequired
statusintegerrequired
Range:
Maximum 599Minimum 400400599topUpUrlstringoptional
Format:
uriMaximum length:
Format uriMaximum length 20482048Headers
traceparentstringrequired
W3C trace context generated for this request attempt.
Pattern:
Pattern ^00-[0-9a-f]{32}-[0-9a-f]{16}-[0-9a-f]{2}$^00-[0-9a-f]{32}-[0-9a-f]{16}-[0-9a-f]{2}$X-Request-Idstringrequired
Unique UUIDv7 identifier for this request attempt.
Format:
Format uuiduuidThe requested resource does not exist or is not available to this organisation.
This response uses Problem Details.
Identity
titlestringrequired
Range:
Maximum length 120Minimum length 11120typestringrequired
Format:
uriMaximum length:
Format uriMaximum length 20482048Errors
errorsobject[]required
Range:
Maximum items 100Minimum items 11100codestringrequired
Range:
Maximum length 80Minimum length 1180messagestringrequired
Range:
Maximum length 500Minimum length 11500pointerstringrequired
Format:
starts_withPattern:
Format starts_withPattern ^\/.*^\/.*availableCreditUsdstringoptional
Pattern:
Pattern ^(?:0|[1-9]\d*)\.\d{2,6}$^(?:0|[1-9]\d*)\.\d{2,6}$codestringrequired
Range:
Maximum length 80Minimum length 1180detailstringrequired
Range:
Maximum length 1000Minimum length 111000instancestringrequired
Format:
starts_withPattern:
Format starts_withPattern ^\/.*^\/.*paramstringoptional
Range:
Maximum length 160Minimum length 11160requestIdstringrequired
Format:
uuidPattern:
Format uuidPattern ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-7[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-7[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$requiredCreditUsdstringoptional
Pattern:
Pattern ^(?:0|[1-9]\d*)\.\d{2,6}$^(?:0|[1-9]\d*)\.\d{2,6}$retryablebooleanrequired
statusintegerrequired
Range:
Maximum 599Minimum 400400599topUpUrlstringoptional
Format:
uriMaximum length:
Format uriMaximum length 20482048Headers
traceparentstringrequired
W3C trace context generated for this request attempt.
Pattern:
Pattern ^00-[0-9a-f]{32}-[0-9a-f]{16}-[0-9a-f]{2}$^00-[0-9a-f]{32}-[0-9a-f]{16}-[0-9a-f]{2}$X-Request-Idstringrequired
Unique UUIDv7 identifier for this request attempt.
Format:
Format uuiduuidThe server did not complete the request in time. This failure is non-billable and may be retried.
This response uses Problem Details.
Identity
titlestringrequired
Range:
Maximum length 120Minimum length 11120typestringrequired
Format:
uriMaximum length:
Format uriMaximum length 20482048Errors
errorsobject[]required
Range:
Maximum items 100Minimum items 11100codestringrequired
Range:
Maximum length 80Minimum length 1180messagestringrequired
Range:
Maximum length 500Minimum length 11500pointerstringrequired
Format:
starts_withPattern:
Format starts_withPattern ^\/.*^\/.*availableCreditUsdstringoptional
Pattern:
Pattern ^(?:0|[1-9]\d*)\.\d{2,6}$^(?:0|[1-9]\d*)\.\d{2,6}$codestringrequired
Range:
Maximum length 80Minimum length 1180detailstringrequired
Range:
Maximum length 1000Minimum length 111000instancestringrequired
Format:
starts_withPattern:
Format starts_withPattern ^\/.*^\/.*paramstringoptional
Range:
Maximum length 160Minimum length 11160requestIdstringrequired
Format:
uuidPattern:
Format uuidPattern ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-7[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-7[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$requiredCreditUsdstringoptional
Pattern:
Pattern ^(?:0|[1-9]\d*)\.\d{2,6}$^(?:0|[1-9]\d*)\.\d{2,6}$retryablebooleanrequired
statusintegerrequired
Range:
Maximum 599Minimum 400400599topUpUrlstringoptional
Format:
uriMaximum length:
Format uriMaximum length 20482048Headers
Retry-Afterintegeroptional
Minimum number of seconds before retrying when supplied.
Range:
Maximum 2147483647Minimum 002147483647traceparentstringrequired
W3C trace context generated for this request attempt.
Pattern:
Pattern ^00-[0-9a-f]{32}-[0-9a-f]{16}-[0-9a-f]{2}$^00-[0-9a-f]{32}-[0-9a-f]{16}-[0-9a-f]{2}$X-Request-Idstringrequired
Unique UUIDv7 identifier for this request attempt.
Format:
Format uuiduuidThe organisation request rate was exceeded. Retry after the indicated delay.
This response uses Problem Details.
Identity
titlestringrequired
Range:
Maximum length 120Minimum length 11120typestringrequired
Format:
uriMaximum length:
Format uriMaximum length 20482048Errors
errorsobject[]required
Range:
Maximum items 100Minimum items 11100codestringrequired
Range:
Maximum length 80Minimum length 1180messagestringrequired
Range:
Maximum length 500Minimum length 11500pointerstringrequired
Format:
starts_withPattern:
Format starts_withPattern ^\/.*^\/.*availableCreditUsdstringoptional
Pattern:
Pattern ^(?:0|[1-9]\d*)\.\d{2,6}$^(?:0|[1-9]\d*)\.\d{2,6}$codestringrequired
Range:
Maximum length 80Minimum length 1180detailstringrequired
Range:
Maximum length 1000Minimum length 111000instancestringrequired
Format:
starts_withPattern:
Format starts_withPattern ^\/.*^\/.*paramstringoptional
Range:
Maximum length 160Minimum length 11160requestIdstringrequired
Format:
uuidPattern:
Format uuidPattern ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-7[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-7[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$requiredCreditUsdstringoptional
Pattern:
Pattern ^(?:0|[1-9]\d*)\.\d{2,6}$^(?:0|[1-9]\d*)\.\d{2,6}$retryablebooleanrequired
statusintegerrequired
Range:
Maximum 599Minimum 400400599topUpUrlstringoptional
Format:
uriMaximum length:
Format uriMaximum length 20482048Headers
Retry-Afterintegeroptional
Minimum number of seconds before retrying when supplied.
Range:
Maximum 2147483647Minimum 002147483647traceparentstringrequired
W3C trace context generated for this request attempt.
Pattern:
Pattern ^00-[0-9a-f]{32}-[0-9a-f]{16}-[0-9a-f]{2}$^00-[0-9a-f]{32}-[0-9a-f]{16}-[0-9a-f]{2}$X-Request-Idstringrequired
Unique UUIDv7 identifier for this request attempt.
Format:
Format uuiduuidThe service or durable usage settlement is temporarily unavailable. This failure is non-billable.
This response uses Problem Details.
Identity
titlestringrequired
Range:
Maximum length 120Minimum length 11120typestringrequired
Format:
uriMaximum length:
Format uriMaximum length 20482048Errors
errorsobject[]required
Range:
Maximum items 100Minimum items 11100codestringrequired
Range:
Maximum length 80Minimum length 1180messagestringrequired
Range:
Maximum length 500Minimum length 11500pointerstringrequired
Format:
starts_withPattern:
Format starts_withPattern ^\/.*^\/.*availableCreditUsdstringoptional
Pattern:
Pattern ^(?:0|[1-9]\d*)\.\d{2,6}$^(?:0|[1-9]\d*)\.\d{2,6}$codestringrequired
Range:
Maximum length 80Minimum length 1180detailstringrequired
Range:
Maximum length 1000Minimum length 111000instancestringrequired
Format:
starts_withPattern:
Format starts_withPattern ^\/.*^\/.*paramstringoptional
Range:
Maximum length 160Minimum length 11160requestIdstringrequired
Format:
uuidPattern:
Format uuidPattern ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-7[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-7[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$requiredCreditUsdstringoptional
Pattern:
Pattern ^(?:0|[1-9]\d*)\.\d{2,6}$^(?:0|[1-9]\d*)\.\d{2,6}$retryablebooleanrequired
statusintegerrequired
Range:
Maximum 599Minimum 400400599topUpUrlstringoptional
Format:
uriMaximum length:
Format uriMaximum length 20482048Headers
Retry-Afterintegeroptional
Minimum number of seconds before retrying when supplied.
Range:
Maximum 2147483647Minimum 002147483647traceparentstringrequired
W3C trace context generated for this request attempt.
Pattern:
Pattern ^00-[0-9a-f]{32}-[0-9a-f]{16}-[0-9a-f]{2}$^00-[0-9a-f]{32}-[0-9a-f]{16}-[0-9a-f]{2}$X-Request-Idstringrequired
Unique UUIDv7 identifier for this request attempt.
Format:
Format uuiduuid