{"openapi":"3.1.0","info":{"title":"Apizie","version":"2.0.0","description":"One API key, one envelope, many public data sources."},"servers":[{"url":"https://zieapi.vercel.app"}],"security":[{"ApiKeyAuth":[]}],"paths":{"/v1/open-data:dataatwork/get-jobs":{"get":{"operationId":"open_data_dataatwork_get_jobs","summary":"Job Titles and Descriptions","description":"GET /jobs","tags":["open-data"],"parameters":[{"name":"offset","in":"query","required":false,"description":"Pagination offset. Default is 0.","schema":{"type":"integer","description":"Pagination offset. Default is 0."}},{"name":"limit","in":"query","required":false,"description":"Maximum number of items per page. Default is 20 and cannot exceed 500.","schema":{"type":"integer","description":"Maximum number of items per page. Default is 20 and cannot exceed 500."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/open-data:dataatwork/get-jobs-autocomplete":{"get":{"operationId":"open_data_dataatwork_get_jobs_autocomplete","summary":"Job Title Autocomplete","description":"GET /jobs/autocomplete","tags":["open-data"],"parameters":[{"name":"begins_with","in":"query","required":false,"description":"Find job titles beginning with the given text fragment","schema":{"type":"string","description":"Find job titles beginning with the given text fragment"}},{"name":"contains","in":"query","required":false,"description":"Find job titles containing the given text fragment","schema":{"type":"string","description":"Find job titles containing the given text fragment"}},{"name":"ends_with","in":"query","required":false,"description":"Find job titles ending with the given text fragment","schema":{"type":"string","description":"Find job titles ending with the given text fragment"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/open-data:dataatwork/get-jobs-normalize":{"get":{"operationId":"open_data_dataatwork_get_jobs_normalize","summary":"Job Title Normalization","description":"GET /jobs/normalize","tags":["open-data"],"parameters":[{"name":"job_title","in":"query","required":true,"description":"Find the canonical job title(s) for jobs matching the given text fragment","schema":{"type":"string","description":"Find the canonical job title(s) for jobs matching the given text fragment"}},{"name":"limit","in":"query","required":false,"description":"Maximumn number of job title synonyms to return. Default is 1 and cannot exceed 10.","schema":{"type":"integer","description":"Maximumn number of job title synonyms to return. Default is 1 and cannot exceed 10."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/open-data:dataatwork/get-jobs-unusual-titles":{"get":{"operationId":"open_data_dataatwork_get_jobs_unusual_titles","summary":"Unusual Job Titles","description":"GET /jobs/unusual_titles","tags":["open-data"],"parameters":[],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/open-data:dataatwork/get-jobs-id":{"get":{"operationId":"open_data_dataatwork_get_jobs_id","summary":"Job Title and Description","description":"GET /jobs/{id}","tags":["open-data"],"parameters":[{"name":"id","in":"query","required":true,"description":"The O*NET SOC Code or UUID of the job title to retrieve","schema":{"type":"string","description":"The O*NET SOC Code or UUID of the job title to retrieve"}},{"name":"fips","in":"query","required":false,"description":"The FIPS Code of a Core-Based Statistical Area. Only return the job if present in this area","schema":{"type":"string","description":"The FIPS Code of a Core-Based Statistical Area. Only return the job if present in this area"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/open-data:dataatwork/get-jobs-id-related-jobs":{"get":{"operationId":"open_data_dataatwork_get_jobs_id_related_jobs","summary":"Jobs Associated with a Job","description":"GET /jobs/{id}/related_jobs","tags":["open-data"],"parameters":[{"name":"id","in":"query","required":true,"description":"The UUID of the job to retrieve related jobs for","schema":{"type":"string","description":"The UUID of the job to retrieve related jobs for"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/open-data:dataatwork/get-jobs-id-related-skills":{"get":{"operationId":"open_data_dataatwork_get_jobs_id_related_skills","summary":"Skills Associated with a Job","description":"GET /jobs/{id}/related_skills","tags":["open-data"],"parameters":[{"name":"id","in":"query","required":true,"description":"The UUID of the job to retrieve skills for","schema":{"type":"string","description":"The UUID of the job to retrieve skills for"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/open-data:dataatwork/get-skills":{"get":{"operationId":"open_data_dataatwork_get_skills","summary":"Skill Names and Descriptions","description":"GET /skills","tags":["open-data"],"parameters":[{"name":"offset","in":"query","required":false,"description":"Pagination offset. Default is 0.","schema":{"type":"integer","description":"Pagination offset. Default is 0."}},{"name":"limit","in":"query","required":false,"description":"Maximum number of items per page. Default is 20 and cannot exceed 500.","schema":{"type":"integer","description":"Maximum number of items per page. Default is 20 and cannot exceed 500."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/open-data:dataatwork/get-skills-autocomplete":{"get":{"operationId":"open_data_dataatwork_get_skills_autocomplete","summary":"Skill Name Autocomplete","description":"GET /skills/autocomplete","tags":["open-data"],"parameters":[{"name":"begins_with","in":"query","required":false,"description":"Find skill names beginning with the given text fragment","schema":{"type":"string","description":"Find skill names beginning with the given text fragment"}},{"name":"contains","in":"query","required":false,"description":"Find skill names containing the given text fragment","schema":{"type":"string","description":"Find skill names containing the given text fragment"}},{"name":"ends_with","in":"query","required":false,"description":"Find skill names ending with the given text fragment","schema":{"type":"string","description":"Find skill names ending with the given text fragment"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/open-data:dataatwork/get-skills-normalize":{"get":{"operationId":"open_data_dataatwork_get_skills_normalize","summary":"Skill Name Normalization","description":"GET /skills/normalize","tags":["open-data"],"parameters":[{"name":"skill_name","in":"query","required":true,"description":"Find the canonical skill name(s) for skills matching the given text fragment","schema":{"type":"string","description":"Find the canonical skill name(s) for skills matching the given text fragment"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/open-data:dataatwork/get-skills-id":{"get":{"operationId":"open_data_dataatwork_get_skills_id","summary":"Skill Name and Description","description":"GET /skills/{id}","tags":["open-data"],"parameters":[{"name":"id","in":"query","required":true,"description":"The UUID of the skill name to retrieve","schema":{"type":"string","description":"The UUID of the skill name to retrieve"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/open-data:dataatwork/get-skills-id-related-jobs":{"get":{"operationId":"open_data_dataatwork_get_skills_id_related_jobs","summary":"Jobs Associated with a Skill","description":"GET /skills/{id}/related_jobs","tags":["open-data"],"parameters":[{"name":"id","in":"query","required":true,"description":"The UUID of the skill to retrieve jobs for","schema":{"type":"string","description":"The UUID of the skill to retrieve jobs for"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/open-data:dataatwork/get-skills-id-related-skills":{"get":{"operationId":"open_data_dataatwork_get_skills_id_related_skills","summary":"Skills Associated with a Skill","description":"GET /skills/{id}/related_skills","tags":["open-data"],"parameters":[{"name":"id","in":"query","required":true,"description":"The UUID of the skill to retrieve related skills for","schema":{"type":"string","description":"The UUID of the skill to retrieve related skills for"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}}},"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"x-api-key"}},"schemas":{"RunEnvelope":{"type":"object","required":["project","data","timestamp"],"properties":{"project":{"type":"string","example":"dev-tools:hash"},"data":{},"timestamp":{"type":"string","format":"date-time"}}},"ErrorEnvelope":{"type":"object","properties":{"content":{},"message":{"type":"string"},"errors":{"type":"array","items":{}},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"}}}}}},"responses":{"Error":{"description":"Invalid key, plan gate, rate limit or upstream failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}}}}