Organization API: Org Community Images
Every Organization API operation tagged Org Community Images.
Base URL: https://api.coritan.com/api/v1. Paths below are complete.
To try these requests in the browser, open the interactive Organization API reference.
Operations
Section titled Operations| Method | Path | Summary |
|---|---|---|
| GET | /api/v1/orgs/{org_slug}/staff/community/media |
The organization's community images, newest first, 50 to a page |
| POST | /api/v1/orgs/{org_slug}/staff/community/media/{token}/remove |
Remove an image from the site |
The organization's community images, newest first, 50 to a page
Section titled The organization's community images, newest first, 50 to a pageGET /api/v1/orgs/{org_slug}/staff/community/media
The organization's community images, newest first, 50 to a page.
Each carries who added it (uploader), where it was first used
(used_in, with the page's path), its preview and its size.
Parameters
Section titled Parameters| Name | In | Type | Required | Description |
|---|---|---|---|---|
org_slug |
path | string | yes | |
purpose |
query | string or null | no | |
q |
query | string or null | no | Part of a member's handle, name or email, or of the image's address |
member |
query | integer or null | no | Only this customer's images |
status |
query | string | no | Default: active. |
page |
query | integer | no | Default: 1. |
Responses
Section titled Responses| Status | Meaning |
|---|---|
200 |
Success. |
422 |
The request is not valid. detail lists each problem. |
Remove an image from the site
Section titled Remove an image from the sitePOST /api/v1/orgs/{org_slug}/staff/community/media/{token}/remove
Remove an image from the site. Tier 2.
Deletes the image and its smaller copies from storage, stops serving it
(the page that showed it shows a broken image until someone edits it),
and clears it from the edge caches. The reason goes in the audit log.
The same file cannot be added again.
Parameters
Section titled Parameters| Name | In | Type | Required |
|---|---|---|---|
org_slug |
path | string | yes |
token |
path | string | yes |
Request body
Section titled Request bodyapplication/json (required)
| Field | Type | Required |
|---|---|---|
reason |
string | yes |
Responses
Section titled Responses| Status | Meaning |
|---|---|
200 |
Success. |
422 |
The request is not valid. detail lists each problem. |