{"__v":8,"_id":"575b2ec657b1c00e00556fd1","api":{"auth":"required","params":[],"results":{"codes":[]},"settings":"","url":""},"body":"[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"What features are available via Kindful's API?\"\n}\n[/block]\n####Query for an Organization's metadata\n\n[campaigns](https://developer.kindful.com/docs/campaigns)\n[chapters](doc:chapters) \n[custom_fields](doc:custom_fields) \n[custom_field_groups](doc:custom_field_groups) \n[details](doc:retrieve-organization-details) \n[groups](doc:groups-1) \n[webhooks/verify_event](doc:webhooksverify_event) \n[funds](doc:funds) \n\n####[Importing](https://developer.kindful.com/docs/introduction-to-the-kindful-imports-api)\nSend contact and transaction data into a Kindful Organization account. Our API prevents importing duplicate records based upon criteria that you specify. This means you can do things like update an existing contact based upon criteria beyond an ID (such as an email address).\n\n####[Querying](https://developer.kindful.com/v1.0/docs/intro-to-querying)\n*Query for Contacts and Transactions in an organization's account.* **[Learn more](https://developer.kindful.com/v1.0/docs/intro-to-querying)**\n\n####[Two-way Sync](https://developer.kindful.com/v1.0/docs/setting-up-a-two-way-sync)\nImplement a two-way sync with Kindful using our API\n\n\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"How do you gain access to the API?\"\n}\n[/block]\n####[For Technical Partners](https://developer.kindful.com/v1.0/docs/oauth-account-view)\n\nKindful Partners are required to use oauth2 in their API Application. \n  * Use the [Partner Dashboard] to gain API access - please email partners:::at:::kindful.com to obtain a Partner Dashboard account.\n  * Build & Test your API Application  on our Playground environment and then contact Kindful for Production API access.\n\n ####[For Kindful Customers](https://developer.kindful.com/docs/direct-access)\nKindful Customers (those with an Organization account) can obtain an API key in their Kindful Settings to directly access their Kindful account via the API.\n* Email support@kindful.com to request access to Kindful's API.\n[block:callout]\n{\n  \"type\": \"info\",\n  \"title\": \"Customer API Access\",\n  \"body\": \"If you are a Kindful customer, email support@kindful.com to request access to Kindful's API.\"\n}\n[/block]\n\n[block:callout]\n{\n  \"type\": \"warning\",\n  \"title\": \"Recommended Extension\",\n  \"body\": \"Kindful recommends the use of Postman as we have used and tested with this extension\"\n}\n[/block]\n---\n[< Back to **Build onto Kindful**](https://developer.kindful.com/docs/build-onto-kindful)","category":"575833c6053a582200067407","createdAt":"2016-06-10T21:19:02.258Z","excerpt":"An overview of API features","githubsync":"","hidden":false,"isReference":false,"link_external":false,"link_url":"","next":{"description":"","pages":[]},"order":0,"parentDoc":null,"project":"550737c0d30b3f190011ba06","slug":"api-categories","sync_unique":"","title":"About the API","type":"basic","updates":[],"user":"5734967dadb9293200842dee","version":"550737c1d30b3f190011ba09","childrenPages":[]}

About the API

An overview of API features

[block:api-header] { "type": "basic", "title": "What features are available via Kindful's API?" } [/block] ####Query for an Organization's metadata [campaigns](https://developer.kindful.com/docs/campaigns) [chapters](doc:chapters) [custom_fields](doc:custom_fields) [custom_field_groups](doc:custom_field_groups) [details](doc:retrieve-organization-details) [groups](doc:groups-1) [webhooks/verify_event](doc:webhooksverify_event) [funds](doc:funds) ####[Importing](https://developer.kindful.com/docs/introduction-to-the-kindful-imports-api) Send contact and transaction data into a Kindful Organization account. Our API prevents importing duplicate records based upon criteria that you specify. This means you can do things like update an existing contact based upon criteria beyond an ID (such as an email address). ####[Querying](https://developer.kindful.com/v1.0/docs/intro-to-querying) *Query for Contacts and Transactions in an organization's account.* **[Learn more](https://developer.kindful.com/v1.0/docs/intro-to-querying)** ####[Two-way Sync](https://developer.kindful.com/v1.0/docs/setting-up-a-two-way-sync) Implement a two-way sync with Kindful using our API [block:api-header] { "type": "basic", "title": "How do you gain access to the API?" } [/block] ####[For Technical Partners](https://developer.kindful.com/v1.0/docs/oauth-account-view) Kindful Partners are required to use oauth2 in their API Application. * Use the [Partner Dashboard] to gain API access - please email partners@kindful.com to obtain a Partner Dashboard account. * Build & Test your API Application on our Playground environment and then contact Kindful for Production API access. ####[For Kindful Customers](https://developer.kindful.com/docs/direct-access) Kindful Customers (those with an Organization account) can obtain an API key in their Kindful Settings to directly access their Kindful account via the API. * Email support@kindful.com to request access to Kindful's API. [block:callout] { "type": "info", "title": "Customer API Access", "body": "If you are a Kindful customer, email support@kindful.com to request access to Kindful's API." } [/block] [block:callout] { "type": "warning", "title": "Recommended Extension", "body": "Kindful recommends the use of Postman as we have used and tested with this extension" } [/block] --- [< Back to **Build onto Kindful**](https://developer.kindful.com/docs/build-onto-kindful)