# Tahdah API ## Docs - [Introduction](https://developers.tahdah.me/introduction-872836m0.md): - [Webhooks](https://developers.tahdah.me/webhooks-872846m0.md): - TrustGroups [About Trust Groups](https://developers.tahdah.me/about-trust-groups-871670m0.md): ## API Docs - TrustGroups > Endpoints [List Trust Groups](https://developers.tahdah.me/list-trust-groups-14714405e0.md): List of trust groups owned by the given legal entity - TrustGroups > Endpoints [Create a Trust Group](https://developers.tahdah.me/create-a-trust-group-14714406e0.md): Create a trust group for the legal entity - TrustGroups > Endpoints [Update Trust Group](https://developers.tahdah.me/update-trust-group-14714408e0.md): Edit a trust group - TrustGroups > Endpoints [List Trust Group Legal Entity Members](https://developers.tahdah.me/list-trust-group-legal-entity-members-14714431e0.md): Provides a list of all legal entities that are members of any trust group owned by the given legal entity. - TrustGroups > Endpoints [List Trust Group Candidate Members](https://developers.tahdah.me/list-trust-group-candidate-members-14714266e0.md): Provides a list of all people that are members of any trust group owned by the given legal entity, or any of the provided trust groups - TrustGroups > Endpoints [Add Trust Group Member](https://developers.tahdah.me/add-trust-group-member-15829087e0.md): Adds a legal entity to a trust group. You must provide in the PUT body the **legalEntityId**, which is the tahdah id of the legal entity. - TrustGroups > Endpoints [Remove Trust Group Member](https://developers.tahdah.me/remove-trust-group-member-15829103e0.md): Removes the provided legal entity from the trust group by terminating their membership. - TrustGroups > Webhooks [Member Added](https://developers.tahdah.me/member-added-14715908e0.md): - TrustGroups > Webhooks [Member Updated](https://developers.tahdah.me/member-updated-14715912e0.md): - EventCredits > Webhooks [Event Credits Updated](https://developers.tahdah.me/event-credits-updated-14715931e0.md): This webhook triggers after a provider allocates one or more event credits to an event and contains details of the new balance for each event credit and details of what the credits were used for during this operation. - EventCredits [Add Credits to Legal Entity](https://developers.tahdah.me/add-credits-to-legal-entity-14714500e0.md): # Add or Remove Event Credits - Tracker [Get Candidate Trackers](https://developers.tahdah.me/get-candidate-trackers-14715938e0.md): Lists all candidate trackers visible to the given legal entity - Tracker [Get Legal Entity Targets](https://developers.tahdah.me/get-legal-entity-targets-14753260e0.md): Gets a list of all targets for a legal entity - LearningExperiences > EndPoints [Register Learners on a Learning Experience](https://developers.tahdah.me/register-learners-on-a-learning-experience-15830274e0.md): Registers one or more learners on a learning experience using the tahdah candidate id. Before registering you need to call the create candidate endpoint to create the learner and get their id. - LearningExperiences > EndPoints [Get Learning Experiences](https://developers.tahdah.me/get-learning-experiences-19733175e0.md): Gets details of all learning experiences for the provided legal entity - LearningExperiences > EndPoints [Get Learning Experience](https://developers.tahdah.me/get-learning-experience-19733178e0.md): Gets details of a learning experience - DigitalBadges [Issue Digital Badge](https://developers.tahdah.me/issue-digital-badge-16959789e0.md): Issues a digital badge to an individual in real-time using the details provided. A digital badge "template" must already have been created within tahdah using the admin interface and you will need to obtain the id for the template using getTemplates API call or from the URL within the admin interface. - DigitalBadges [Get Badge Templates](https://developers.tahdah.me/get-badge-templates-16960712e0.md): Retrieves a list of badge templates available for the provided legal entity. - LegalEntities > Endpoints [Legal Entity Details](https://developers.tahdah.me/legal-entity-details-15808437e0.md): Get basic details for a legal entity. - LegalEntities > Endpoints [Create Legal Entity](https://developers.tahdah.me/create-legal-entity-15829072e0.md): Creates a new legal entity and returns the id of the newly created legal entity. You can also provide a list of trust group ids to add the legal entity to. For details about how trust groups work see https://developers.tahdah.me/about-trust-groups-871670m0 - LegalEntities > Endpoints [Connect a Person to a Legal Entity](https://developers.tahdah.me/connect-a-person-to-a-legal-entity-15830574e0.md): Add staff and candidates to legal entities. Before calling this method you need to have already created a legal entity and that legal entity must be a member of a trust group that your organisation owns, any people you want to add must also already have been created as candidates and any roles required must already exist. - Candidates > EndPoints [Create Candidate](https://developers.tahdah.me/create-candidate-15830528e0.md): Creates a new candidate and links to the legal entity connected to the provided API Key. - Candidates > EndPoints [Update a Candidate](https://developers.tahdah.me/update-a-candidate-15830556e0.md): Updates the details of a candidate. - Candidates > EndPoints [Delete Candidate](https://developers.tahdah.me/delete-candidate-15830562e0.md): Delete a Candidate - Candidates > EndPoints [Add/Remove tags to a candidate](https://developers.tahdah.me/addremove-tags-to-a-candidate-15830564e0.md): Updates the tags of a candidate. - Catalogues > Webhooks [Catalogue Entry Created](https://developers.tahdah.me/catalogue-entry-created-25151556e0.md): This webhook triggers when a new entry is published to a catalogue that is owned by the subscribed legal entity. Since this is a webhook the Request details below are we what we send you and the Response are what we expect back from you. ## Schemas - Events [EventTemplateCreditRequest](https://developers.tahdah.me/eventtemplatecreditrequest-5624364d0.md): - Events [EventTemplateCredit](https://developers.tahdah.me/eventtemplatecredit-5625540d0.md): - Catalogue [CatalogueEntry](https://developers.tahdah.me/catalogueentry-11411052d0.md): - [TrustGroupMember](https://developers.tahdah.me/trustgroupmember-5610008d0.md): - [temp](https://developers.tahdah.me/temp-5625610d0.md): - [LegalEntity](https://developers.tahdah.me/legalentity-6177495d0.md): - [legalEntityIdentifier](https://developers.tahdah.me/legalentityidentifier-6177553d0.md): - [Candidate](https://developers.tahdah.me/candidate-6177617d0.md):