# Contribly API > Contribly API on Apizie: 44 endpoints (Artifact formats, List assignments, Create a new assignment, Get a single assigment by id, …) returned as clean JSON through one API key. Send your own provider key in the x-upstream-key header. Call it over REST at https://www.apizie.tech/v1/social-media:contribly/{endpoint} or from Claude, ChatGPT and Cursor through the Apizie MCP server. Free plan: 1,000 requests a month. - Project key: `social-media:contribly` - Category: Social Media - Status: byok - Source: https://contribly.com - Page: https://www.apizie.tech/api/social-media/contribly - OpenAPI: https://www.apizie.tech/api/social-media/contribly/openapi.json ## Endpoints ### Artifact formats `GET https://www.apizie.tech/v1/social-media:contribly/get-artifact-formats` (byok) ### List assignments `GET https://www.apizie.tech/v1/social-media:contribly/get-assignments` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | ownedBy | string | no | Restrict results to assignments owned by this user. | | page | integer | no | Pagination page | | pageSize | integer | no | Pagination page size | | q | string | no | Restrict results to assignments whose name or description matches this keyword. | | urlWords | string | no | Select an assignment by urlWords. | | open | boolean | no | Select open or closed assignments | | alwaysOpen | boolean | no | Select assignments with no closing date. | | tag | string | no | Restrict results to assignments which are tagged with this tag. | | name | string | no | Restrict results to the assignment (or potentially assignments) with this exact name | ### Create a new assignment `POST https://www.apizie.tech/v1/social-media:contribly/post-assignments` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | body | object | yes | JSON request body | ### Get a single assigment by id `GET https://www.apizie.tech/v1/social-media:contribly/get-assignments-id` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | id | string | yes | Id of the assignment to return | ### Delete this assignment and all of it's contributions `POST https://www.apizie.tech/v1/social-media:contribly/delete-assignments-id` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | id | string | yes | Id of the assignment to return | ### Recent changes `GET https://www.apizie.tech/v1/social-media:contribly/get-change-log` (byok) ### List valid contribution refinement types `GET https://www.apizie.tech/v1/social-media:contribly/get-contribution-refinement-types` (byok) ### List contribution refinement options `GET https://www.apizie.tech/v1/social-media:contribly/get-contribution-refinements` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | assignment | string | no | Restrict results to contributions submitted to this assignment. | | country | string | no | Limit results to contributions which have a publicly visible location within the given country (specified by two letter country code). | | createdBefore | string | no | Limit results to contributions created before this date time. | | createdAfter | string | no | Limit results to contributions created after this date time. | | geohash | string | no | Restrict results to contributions which have specified a location which falls within this geohash (or comma seperated list of multiple… | | hasLocation | boolean | no | Restrict results to contributions which have a publicly visible location. | | latLong | string | no | Limit results to contributions with location near this latitude and longitude (comma seperated lat/long pair). Also see radius | | radius | number | no | When limiting result by location with the latLong parameter, specify the radius in kilometers. | | mediaType | string | no | Restrict results to contributions which include a media file of the given type (ie. image / video) | | ownedBy | string | no | Restrict results to contributions which are fall under the jurisdiction by this user. | | q | string | no | Restrict results to contributions whose headline text matches this keyword. | | urlWords | string | no | Locate a specific contribution by URL words | | user | string | no | Restrict results to contributions by this user identified by id. | | refinements | string | no | Comma seperated list of refinement names. | | refinementSize | number | no | Number of refinement options to return. | ### List contributions `GET https://www.apizie.tech/v1/social-media:contribly/get-contributions` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | assignment | string | no | Restrict results to contributions submitted to this assignment. | | country | string | no | Limit results to contributions which have a publicly visible location within the given country (specified by two letter country code). | | createdBefore | string | no | Limit results to contributions created before this date time. | | createdAfter | string | no | Limit results to contributions created after this date time. | | createdDay | string | no | Limit results to contributions created on this day. | | createdMonth | string | no | Limit results to contributions created during this month. | | geohash | string | no | Restrict results to contributions which have specified a location which falls within this geohash (or comma seperated list of multiple… | | hasLocation | boolean | no | Restrict results to contributions which have a publicly visible location. | | latLong | string | no | Limit results to contributions with location near this latitude and longitude (comma seperated lat/long pair). Also see radius | | radius | number | no | When limiting result by location with the latLong parameter, specify the radius in kilometers. | | mediaType | string | no | Restrict results to contributions which include a media file of the given type (ie. image / video) | | ownedBy | string | no | Restrict results to contributions which are fall under the jurisdiction by this user. | | q | string | no | Restrict results to contributions whose headline text matches this keyword. | | urlWords | string | no | Locate a specific contribution by URL words | | user | string | no | Restrict results to contributions by this user identified by id. | | ids | string | no | Restrict results to a list of specific contributions identified by a comma seperated list of ids. | | format | string | no | Select output format. 'json' or 'rss'. Defaults to JSON. | ### Create a new contribution `POST https://www.apizie.tech/v1/social-media:contribly/post-contributions` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | body | object | yes | JSON request body | ### Get a single contribution by id `GET https://www.apizie.tech/v1/social-media:contribly/get-contributions-id` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | id | string | yes | Id of the contribution to return | ### Delete this contribution `POST https://www.apizie.tech/v1/social-media:contribly/delete-contributions-id` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | id | string | yes | Id of the contribution to delete | ### Raise a flag against this contribution `POST https://www.apizie.tech/v1/social-media:contribly/post-contributions-id-flag` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | id | string | yes | Id of the contribution to flag | | body | object | yes | JSON request body | ### Allows a user to mark a contribution as liked `POST https://www.apizie.tech/v1/social-media:contribly/post-contributions-id-like` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | id | string | yes | Id of the contribution | ### List users who have liked this contributions `GET https://www.apizie.tech/v1/social-media:contribly/get-contributions-id-likes` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | id | string | yes | Id of the contribution | ### Perform a moderation action on this contribution `POST https://www.apizie.tech/v1/social-media:contribly/post-contributions-id-moderate` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | id | string | yes | Id of the contribution to moderate | | body | object | yes | JSON request body | ### List the credentials associated with the authenticated user. `GET https://www.apizie.tech/v1/social-media:contribly/get-credentials` (byok) ### Event types `GET https://www.apizie.tech/v1/social-media:contribly/get-event-types` (byok) ### Export contributions. `POST https://www.apizie.tech/v1/social-media:contribly/post-export` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | assignment | string | no | Restrict results to contributions submitted to this assignment. | | country | string | no | Limit results to contributions which have a publicly visible location within the given country (specified by two letter country code). | | createdBefore | string | no | Limit results to contributions created before this date time. | | createdAfter | string | no | Limit results to contributions created after this date time. | | geohash | string | no | Restrict results to contributions which have specified a location which falls within this geohash (or comma seperated list of multiple… | | hasLocation | boolean | no | Restrict results to contributions which have a publicly visible location. | | latLong | string | no | Limit results to contributions with location near this latitude and longitude (comma seperated lat/long pair). Also see radius | | radius | number | no | When limiting result by location with the latLong parameter, specify the radius in kilometers. | | mediaType | string | no | Restrict results to contributions which include a media file of the given type (ie. image / video) | | ownedBy | string | no | Restrict results to contributions which are fall under the jurisdiction by this user. | | q | string | no | Restrict results to contributions whose headline text matches this keyword. | | urlWords | string | no | Locate a specific contribution by URL words | | user | string | no | Restrict results to contributions by this user identified by id. | | tagged | boolean | no | Should exported media files be tagged with metadata. Deprecated; use format instead. | | combined | boolean | no | Included a combined file with all contribution text. | | individual | boolean | no | Include individual text files for each contribution. | | format | string | no | Media format to export; none, fullsize, tagged or original. | | json | boolean | no | Include raw JSON for each contribution. | ### Export contributions preflight summary. `POST https://www.apizie.tech/v1/social-media:contribly/post-export-summary` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | assignment | string | no | Restrict results to contributions submitted to this assignment. | | country | string | no | Limit results to contributions which have a publicly visible location within the given country (specified by two letter country code). | | createdBefore | string | no | Limit results to contributions created before this date time. | | createdAfter | string | no | Limit results to contributions created after this date time. | | geohash | string | no | Restrict results to contributions which have specified a location which falls within this geohash (or comma seperated list of multiple… | | hasLocation | boolean | no | Restrict results to contributions which have a publicly visible location. | | latLong | string | no | Limit results to contributions with location near this latitude and longitude (comma seperated lat/long pair). Also see radius | | radius | number | no | When limiting result by location with the latLong parameter, specify the radius in kilometers. | | mediaType | string | no | Restrict results to contributions which include a media file of the given type (ie. image / video) | | ownedBy | string | no | Restrict results to contributions which are fall under the jurisdiction by this user. | | q | string | no | Restrict results to contributions whose headline text matches this keyword. | | urlWords | string | no | Locate a specific contribution by URL words | | user | string | no | Restrict results to contributions by this user identified by id. | ### Get a single export job; poll to follow export progress. `GET https://www.apizie.tech/v1/social-media:contribly/get-exports-id` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | id | string | yes | Id of the export job to return | ### List form responses `GET https://www.apizie.tech/v1/social-media:contribly/get-form-responses` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | user | string | no | Restrict results to responses submitted by this user. | | form | string | no | Restrict results to responses submitted to this form. | | contribution | string | no | Restrict results to responses relating to this contribution. | ### Submit a response to a form `POST https://www.apizie.tech/v1/social-media:contribly/post-form-responses` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | body | object | yes | JSON request body | ### Get a single form response by id `GET https://www.apizie.tech/v1/social-media:contribly/get-form-responses-id` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | id | string | yes | Id of the assignment to return | ### List forms `GET https://www.apizie.tech/v1/social-media:contribly/get-forms` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | ownedBy | string | yes | Restrict results to forms owned by this user. | ### Create a form `POST https://www.apizie.tech/v1/social-media:contribly/post-forms` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | body | object | yes | JSON request body | ### Get a single form by id `GET https://www.apizie.tech/v1/social-media:contribly/get-forms-id` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | id | string | yes | Id of the form to return | ### Delete this form and all of it's responses. `POST https://www.apizie.tech/v1/social-media:contribly/delete-forms-id` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | id | string | yes | Id of the form to delete | ### Submit a new media file `POST https://www.apizie.tech/v1/social-media:contribly/post-media` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | body | object | yes | JSON request body | ### GET /notifications/contributions/{id}/preview `GET https://www.apizie.tech/v1/social-media:contribly/get-notifications-contributions-id-preview` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | id | string | yes | Id of the contribution to preview a notification for | | message | string | yes | Type of message to preview. | ### Scopes `GET https://www.apizie.tech/v1/social-media:contribly/get-scopes` (byok) ### Subscription types `GET https://www.apizie.tech/v1/social-media:contribly/get-subscription-types` (byok) ### List subscriptions for the authorised user. `GET https://www.apizie.tech/v1/social-media:contribly/get-subscriptions` (byok) ### Delete a subscription. `POST https://www.apizie.tech/v1/social-media:contribly/delete-subscriptions-id` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | id | string | yes | Id of the subscription to delete | ### List tags `GET https://www.apizie.tech/v1/social-media:contribly/get-tags` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | ownedBy | string | no | Restrict results to those owned by this user. | | tagSet | string | no | Restrict results to tags belonging to this tag set. | | urlWords | string | no | Restrict results by urlWords. Should be used with ownedBy when searching for one of your own tags. | ### Create a new tag `POST https://www.apizie.tech/v1/social-media:contribly/post-tags` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | body | object | yes | JSON request body | ### Retrieve a single tag by id `GET https://www.apizie.tech/v1/social-media:contribly/get-tags-id` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | id | string | yes | Id of the tag to return | ### List tag sets `GET https://www.apizie.tech/v1/social-media:contribly/get-tagsets` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | ownedBy | string | no | Restrict results to those owned by this user. | | urlWords | string | no | Restrict results by urlWords. Should be used with ownedBy when searching for one of your own tag sets. | ### Create a new tag set `POST https://www.apizie.tech/v1/social-media:contribly/post-tagsets` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | body | object | yes | JSON request body | ### Retrieve a single tag set by id `GET https://www.apizie.tech/v1/social-media:contribly/get-tagsets-id` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | id | string | yes | Id of the tag set to return | ### List users `GET https://www.apizie.tech/v1/social-media:contribly/get-users` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | assignment | string | no | Restrict results to the users who have contributed to this assignment. | | country | string | no | Restrict results to the users who have submitted a contribution with a public location located within this country. | | minimumContributions | number | no | Restrict results to the users who have submitted at least this many contributions. | | linkedProfile | string | no | Restrict results to the users who a linked profile of this type. | | ownedBy | string | no | Restrict results to the users who are owned by of this owner. | | submittedBefore | string | no | Limit results to users who have submitted at least one contribution before this date time. | | submittedAfter | string | no | Limit results to users who have submitted at least one contribution after this date time. | | username | string | no | Restrict results to the user with this username. | ### Retrieve a single user by id `GET https://www.apizie.tech/v1/social-media:contribly/get-users-id` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | id | string | yes | Id of the user to return | ### Retrieve a users linked profile by type `GET https://www.apizie.tech/v1/social-media:contribly/get-users-id-linked-type` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | id | string | yes | Id of the user to return | | type | string | yes | Type of the linked profile to fetch | ### Verify token and return details of the owning user `POST https://www.apizie.tech/v1/social-media:contribly/post-verify` (byok) ## Example ``` curl "https://www.apizie.tech/v1/social-media:contribly/get-artifact-formats" \ -H "x-api-key: $APIZIE_KEY" \ -H "x-upstream-key: $PROVIDER_KEY" ``` ## FAQ ### How do I call the Contribly API? Create a free Apizie key, then send GET https://www.apizie.tech/v1/social-media:contribly/get-artifact-formats with the header x-api-key. Every endpoint returns { project, data, timestamp }. ### Is the Contribly API free on Apizie? Yes. The Free plan includes 1,000 requests a month at 100 requests a minute, no credit card. Contribly itself also needs your own key from contribly.com. ### Can AI agents use the Contribly API? Yes. Add the Apizie MCP server (https://www.apizie.tech/mcp) to Claude, ChatGPT, Cursor or VS Code, then ask in plain language. The agent calls run_scraper with project key social-media:contribly. ### What is the status of the Contribly API? Needs your own provider key (bring your own key)