List organisations
list_organisationsRetrieve or filter clubs and other organisations from a sports membership platform by type, status, location, or modification date.
Instructions
Clubs and other organisations with number, type, status, town, region, website and join link. Email, phone, street address, postcode and map position only with include_contact_details (a club's contact details are often a volunteer's own).
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| page | No | Page to start from (1 is the first page; use next_page from a previous call to continue) | |
| type | No | Organisation type (Type) | |
| status | No | Status (Status) | |
| max_pages | No | How many pages to fetch in this call | |
| page_size | No | Records per page (1-100) | |
| credential_id | No | Organisations holding this credential (CredentialId) | |
| modified_after | No | Only records modified after this date-time (ModifiedAfter). A bare date is sent as midnight UTC that day. | |
| membership_name | No | Membership name (MembershipName) | |
| modified_before | No | Only records modified before this date-time (ModifiedBefore). A bare date is sent as midnight UTC that day. | |
| organisation_id | No | One organisation (OrganisationId) | |
| organisation_number | No | Organisation number (OrganisationNumber) | |
| include_contact_details | No | Include email, phone, street address, postcode and map position |