/osf/registrations

POST /api/osf/registrations

Price: 5 credits

Get one OSF registration — a frozen, time-stamped record of a study plan or of a completed project — by its GUID. Returns the registration form it was filled on and the answers given to it, the date it was registered, the embargo and withdrawal state, the DOI OSF minted, the declared availability of data, materials, analytic code and papers, the licence, the project it was registered from, and every named contributor.

How to use it

This is what makes a preregistration readable: `answers` carries the researcher's own responses to the form named by `registration_supplement`, and `answers[].key` is the schema's internal question id, not the question text — the wording lives in the schema, not in the record. `registered_at` is the moment the plan was frozen and is the date to cite; `created_at` is when the underlying project was made. An embargoed registration is listed with its metadata while `is_embargoed` is true and `embargo_end_date` says when the content opens. `registered_from_id` is the project GUID this was made from, which /osf/nodes resolves. A registration GUID itself resolves only here — /osf/nodes answers 412 for it.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• registration string required — OSF registration GUID — the five characters after osf.io/ — or the address of its page (examples: "pk78q", "https://osf.io/pk78q/"; minLength: 1)

Response

• @type string (default: "OsfRegistrationDetail")
• id string required
• url string required
• description string nullable
• category string nullable
• registration_supplement string nullable
• created_at string nullable
• modified_at string nullable
• registered_at string nullable
• withdrawn_at string nullable
• embargo_end_date string nullable
• reviews_state string nullable
• revision_state string nullable
• article_doi string nullable
• archive_url string nullable
• withdrawal_justification string nullable
• tags array (default: [])
• subjects array (default: [])
  • @type string (default: "OsfSubject")
  • id string required
  • text string required
  • path array (default: [])
• license_record object nullable
  • @type string (default: "OsfLicenseRecord")
  • year string nullable
  • copyright_holders array (default: [])
• is_public boolean nullable
• is_embargoed boolean nullable
• is_withdrawn boolean nullable
• is_archiving boolean nullable
• is_fork boolean nullable
• is_collection boolean nullable
• is_preprint boolean nullable
• is_wiki_enabled boolean nullable
• has_project boolean nullable
• has_data boolean nullable
• has_materials boolean nullable
• has_analytic_code boolean nullable
• has_papers boolean nullable
• has_supplements boolean nullable
• is_pending_registration_approval boolean nullable
• is_pending_embargo_approval boolean nullable
• is_pending_embargo_termination_approval boolean nullable
• is_pending_withdrawal boolean nullable
• are_access_requests_enabled boolean nullable
• doi string nullable
• ark string nullable
• provider_id string nullable
• schema_id string nullable
• registered_by_id string nullable
• registered_from_id string nullable
• root_id string nullable
• storage_region string nullable
• license object nullable
  • @type string (default: "OsfLicense")
  • id string nullable
  • name string nullable
  • url string nullable
  • required_fields array (default: [])
• contributors array (default: [])
  • @type string (default: "OsfContributor")
  • id string nullable
  • full_name string required
  • given_name string nullable
  • family_name string nullable
  • middle_names string nullable
  • suffix string nullable
  • orcid string nullable
  • profile_url string nullable
  • image string nullable
  • permission string nullable
  • index integer nullable
  • is_bibliographic boolean nullable
  • is_registered boolean nullable
  • is_active boolean nullable
  • is_curator boolean nullable
  • locale string nullable
  • timezone string nullable
  • registered_at string nullable
  • employment array (default: [])
    • @type string (default: "OsfPosition")
    • institution string required
    • department string nullable
    • degree string nullable
    • start_year integer nullable
    • start_month integer nullable
    • end_year integer nullable
    • end_month integer nullable
    • is_ongoing boolean nullable
  • education array (default: [])
    • @type string (default: "OsfPosition")
    • institution string required
    • department string nullable
    • degree string nullable
    • start_year integer nullable
    • start_month integer nullable
    • end_year integer nullable
    • end_month integer nullable
    • is_ongoing boolean nullable
  • social object nullable
    • @type string (default: "OsfSocialProfiles")
    • github string nullable
    • linkedin string nullable
    • twitter string nullable
    • google_scholar string nullable
    • research_gate string nullable
    • researcher_id string nullable
    • impact_story string nullable
    • academia_profile_id string nullable
    • academia_institution string nullable
    • baidu_scholar string nullable
    • ssrn string nullable
    • websites array (default: [])
• affiliated_institutions array (default: [])
  • @type string (default: "OsfInstitution")
  • id string required
  • name string nullable
  • url string nullable
  • ror_url string nullable
• answers array (default: [])
  • @type string (default: "OsfRegistrationAnswer")
  • key string required
  • answers array (default: [])

Errors

• 422 — The request body did not validate Check the fields against this schema. A URN with the wrong prefix is the most common cause.
• 408 — The request ran past its time limit Raise `timeout` in the request body, up to the maximum this endpoint documents. Lowering `count` or turning off the `with_*` flags also helps, because less work finishes sooner.
• 412 — No public OSF registration carries this GUID Retrying will not help: either the entity does not exist, or the input points at a different one.
• 429 — Too many requests: a rate limit or a usage window is exhausted When the response carries an X-Retry-After header, wait that many seconds and retry: the same number is in the body as `detail.retry_after`, and the limit clears once that window passes. The message in the body names the limit that was hit.
• 500 — Something broke on our side Retrying will not help. If it keeps happening, send us the X-Request-ID from the response headers.
• 529 — Rate limit reached, or the endpoint is overloaded Wait at least 30 seconds, then retry.

Response headers

• X-Error — Error message text (present only on error)
• X-Request-ID — Unique request identifier
• X-Execution-Time — Execution time in seconds
• X-Result-Count — How many records the body carries. 0 means an empty result, which is a normal answer and not by itself an error. A non-zero count can come back together with X-Error when the failure happened partway through — read this header and X-Error independently.
• X-Total-Available-Results — How many records exist for this query, when the endpoint can say. On a `dry_run` request this is the answer and the body is empty. It saturates: the endpoint's documented maximum means 'at least that many', any smaller number is exact.
• X-Warning — Present when the request body carried keys this endpoint does not document. They were ignored, so any filter you meant to apply through them did not apply. Check the spelling against this schema and retry.
• X-Retry-After — Seconds to wait before retrying. Present only on 429.