{"openapi":"3.1.0","info":{"title":"MuslimJobs partner feed","version":"1.0.0","description":"Read-only feed of live MuslimJobs jobs for invited partners. Docs: https://www.muslimjobs.io/developers/docs"},"servers":[{"url":"https://www.muslimjobs.io/api/partner/v1"}],"security":[{"bearer":[]},{"basic":[]}],"paths":{"/jobs":{"get":{"summary":"List jobs","description":"Live jobs ordered by id. Follow next_cursor until it is null.","parameters":[{"name":"limit","in":"query","schema":{"type":"integer","minimum":1,"maximum":100,"default":100}},{"name":"cursor","in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":"A page of jobs.","content":{"application/json":{"schema":{"type":"object","required":["data","next_cursor"],"properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/PartnerJob"}},"next_cursor":{"type":["string","null"]}}}}}},"400":{"description":"key_in_url, invalid_cursor or validation_failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"invalid_key: no key, a wrong key or a revoked key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"partner_paused: access is paused or has ended.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"rate_limited: wait for Retry-After seconds.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/jobs/{id}":{"get":{"summary":"Get one job","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"The job.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartnerJob"}}}},"400":{"description":"key_in_url, invalid_cursor or validation_failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"invalid_key: no key, a wrong key or a revoked key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"partner_paused: access is paused or has ended.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"not_found: no job with that id.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"410":{"description":"job_ended: the job has closed. Remove it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"rate_limited: wait for Retry-After seconds.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/jobs.xml":{"get":{"summary":"XML feed","description":"Every live job in one Indeed-style XML document, rebuilt at most every 10 minutes.","responses":{"200":{"description":"The feed.","content":{"application/xml":{"schema":{"type":"string"}}}},"400":{"description":"key_in_url, invalid_cursor or validation_failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"invalid_key: no key, a wrong key or a revoked key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"partner_paused: access is paused or has ended.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"rate_limited: wait for Retry-After seconds.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/logos/{companyId}.png":{"get":{"summary":"Company logo","description":"A square PNG, at most 256px. Public; fetch once and keep a copy.","security":[],"parameters":[{"name":"companyId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"The logo, or a placeholder.","content":{"image/png":{"schema":{"type":"string","format":"binary"}}}}}}}},"components":{"securitySchemes":{"bearer":{"type":"http","scheme":"bearer","description":"Authorization: Bearer KEY"},"basic":{"type":"http","scheme":"basic","description":"Any username; the key is the password."}},"schemas":{"PartnerJob":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"id":{"type":"string","description":"Stable MuslimJobs job id. Use it as your key."},"title":{"type":"string","description":"Job title."},"company":{"type":"object","properties":{"name":{"type":"string","description":"Company name."},"logo_url":{"anyOf":[{"type":"string","format":"uri"},{"type":"null"}],"description":"Square PNG logo (at most 256px) on MuslimJobs, or null."},"url":{"type":"string","format":"uri","description":"Company page on MuslimJobs, with your ref."}},"required":["name","logo_url","url"],"additionalProperties":false,"description":"The hiring company."},"location":{"type":"object","properties":{"city":{"description":"City, or null.","type":["string","null"]},"country":{"type":"string","description":"Country."},"remote":{"anyOf":[{"type":"string","enum":["REMOTE","HYBRID","ONSITE"]},{"type":"null"}],"description":"REMOTE, HYBRID or ONSITE."},"remote_label":{"description":"Display label for remote.","type":["string","null"]}},"required":["city","country","remote","remote_label"],"additionalProperties":false,"description":"Where the job is."},"job_type":{"anyOf":[{"type":"string","enum":["FULL_TIME","PART_TIME","CONTRACT","INTERNSHIP","OTHER"]},{"type":"null"}],"description":"Type of contract."},"job_type_label":{"description":"Display label for job_type.","type":["string","null"]},"category":{"anyOf":[{"type":"string","enum":["ENGINEERING_AND_TECHNOLOGY","SALES_AND_MARKETING","DATA_AND_ANALYTICS","CUSTOMER_SERVICE","BUSINESS_AND_FINANCE","MEDIA","EDUCATION","HEALTH_AND_MEDICINE","LAW_AND_POLICY","OTHER","PRODUCT_AND_DESIGN","ADMINISTRATION","HUMAN_RESOURCES","MANAGEMENT"]},{"type":"null"}],"description":"Job category."},"category_label":{"description":"Display label for category.","type":["string","null"]},"salary":{"description":"Salary as display text, e.g. \"GBP 70,000 - 85,000 / year\".","type":["string","null"]},"experience":{"type":"object","properties":{"min_years":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}],"description":"Minimum years, or null."},"max_years":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}],"description":"Maximum years, or null."}},"required":["min_years","max_years"],"additionalProperties":false,"description":"Years of experience asked for."},"description_html":{"type":"string","description":"Description as HTML: p, br, strong, em, ul, ol, li, a, h2–h4 only."},"description_text":{"type":"string","description":"Description as plain text with line breaks, for apps that can’t render HTML."},"tags":{"type":"array","items":{"type":"string"},"description":"Skills and keywords. May be empty."},"url":{"type":"string","format":"uri","description":"Job page on MuslimJobs, with your ref."},"apply_url":{"type":"string","format":"uri","description":"Job page with apply=1. Use it unchanged for apply buttons."},"published_at":{"type":"string","format":"date-time","pattern":"^(?:(?:\\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))$","description":"When the job went live (ISO 8601)."},"updated_at":{"type":"string","format":"date-time","pattern":"^(?:(?:\\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))$","description":"When the job last changed (ISO 8601)."},"expires_at":{"anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\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))$"},{"type":"null"}],"description":"When the job closes (ISO 8601), or null."},"attribution":{"type":"object","properties":{"text":{"type":"string","const":"via MuslimJobs","description":"Show this next to every job."},"url":{"type":"string","format":"uri","description":"Link the attribution here."},"logo_url":{"type":"string","format":"uri","description":"MuslimJobs logo, SVG."},"logo_png_url":{"type":"string","format":"uri","description":"MuslimJobs logo, PNG, for apps that can’t draw SVG."}},"required":["text","url","logo_url","logo_png_url"],"additionalProperties":false,"description":"Credit to show with every job."}},"required":["id","title","company","location","job_type","job_type_label","category","category_label","salary","experience","description_html","description_text","tags","url","apply_url","published_at","updated_at","expires_at","attribution"],"additionalProperties":false},"Error":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object"}}}}}}}}