/charitycommission/charities/linked_charities

POST /api/charitycommission/charities/linked_charities

Price: 10 credits

Charities linked to a registered charity on the register of England and Wales, each with its own organisation number and, for the one the register expands, its governing document, charitable objects, area of benefit and registration history.

How to use it

A charity with no linked charities returns an empty list, which is the normal case. The register expands the detail of only one linked charity per page load, so `governing_document`, `charitable_objects`, `area_of_benefit` and `registration_history` are filled for that one and empty for the rest — call charitycommission/charities with a linked charity's own suffixed number to get its full profile.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• charity_number string required — Registered charity number as it appears on the register, including the suffix of a linked sub-charity (examples: "1089464", "1089464-1"; minLength: 1)

Response

• @type string (default: "CharitycommissionLinkedCharity")
• name string required
• organisation_number string required
• url string required
• charity_number string nullable
• governing_document string nullable
• charitable_objects string nullable
• area_of_benefit string nullable
• registration_history 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 charity is registered under that number 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.