For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Dashboard
GuidesIntegrationsAPI ReferencesRelease notes
GuidesIntegrationsAPI ReferencesRelease notes
    • APIs overview
  • Upload API
    • Errors
  • REST API
    • Authentication
    • File Metadata
      • GETList of groups
      • GETGroup info
      • DELDelete group
    • Add Ons
    • Changelog
    • Versioning
  • URL API
    • File groups
    • Image processing limitations
    • Image compression
    • Image resize and crop
    • Image rotation
    • Image overlays
    • Image colors
    • Image definition
    • Image recognition
    • Other image operations
    • Proxy
    • Signed URLs
    • CDN settings
    • Integrations
Dashboard
LogoLogo
REST APIGroup

List of groups

GET
https://api.uploadcare.com/groups/
GET
/groups/
$curl https://api.uploadcare.com/groups/ \
>     -H "Accept: application/vnd.uploadcare-v0.7+json" \
>     -H "Authorization: <apiKey>"
1{
2  "next": "https://api.uploadcare.com/groups/?limit=3&from=2016-11-09T14%3A30%3A22.421889%2B00%3A00&offset=0",
3  "previous": null,
4  "total": 100,
5  "per_page": 2,
6  "results": [
7    {
8      "id": "dd43982b-5447-44b2-86f6-1c3b52afa0ff~1",
9      "datetime_created": "2018-11-27T14:14:37.583654Z",
10      "files_count": 1,
11      "cdn_url": "https://ucarecdn.com/dd43982b-5447-44b2-86f6-1c3b52afa0ff~1/",
12      "url": "https://api.uploadcare.com/groups/dd43982b-5447-44b2-86f6-1c3b52afa0ff~1/"
13    },
14    {
15      "id": "fd59dbcb-40a1-4f3a-8062-cc7d23f66885~1",
16      "datetime_created": "2018-11-27T15:14:39.586674Z",
17      "files_count": 1,
18      "cdn_url": "https://ucarecdn.com/fd59dbcb-40a1-4f3a-8062-cc7d23f66885~1/",
19      "url": "https://api.uploadcare.com/groups/fd59dbcb-40a1-4f3a-8062-cc7d23f66885~1/"
20    }
21  ]
22}
Get a paginated list of groups.
Was this page helpful?
Previous

Group info

Next
Built with

Authentication

Authorizationstring
Every request made to `https://api.uploadcare.com/` MUST be signed. HTTPS SHOULD be used with any authorization scheme. Requests MUST contain the `Authorization` header defining `auth-scheme` and `auth-param`: `Authorization: auth-scheme auth-param`. Every request MUST contain the `Accept` header identifying the REST API version: `Accept: application/vnd.uploadcare-v0.7+json`. There are two available authorization schemes: * For production: `Uploadcare`, a scheme where a `signature`, not your Secret API Key MUST be specified. Signatures SHOULD be generated on backend. * For quick tests: `Uploadcare.Simple`, a simple scheme where your [Secret API Key](https://app.uploadcare.com/projects/-/api-keys/) MUST be specified in every request's `auth-param`.

Headers

AcceptenumRequired
Version header.
Allowed values:

Query parameters

limitintegerOptional
A preferred amount of groups in a list for a single response. Defaults to 100, while the maximum is 1000.
fromdatetimeOptional

A starting point for filtering the list of groups. If passed, MUST be a date and time value in ISO-8601 format.

orderingenumOptionalDefaults to datetime_created

Specifies the way groups should be sorted in the returned list. datetime_created for the ascending order (default), -datetime_created for the descending one.

Allowed values:

Response

A list of groups, paginated.
nextstring or nullformat: "uri"
Next page URL.
previousstring or nullformat: "uri"
Previous page URL.
totalinteger>=0
Total number of groups in the project.
per_pageinteger
Number of groups per page.
resultslist of objects

Errors

400
Bad Request Error
401
Unauthorized Error
406
Not Acceptable Error
429
Too Many Requests Error

Every request made to https://api.uploadcare.com/ MUST be signed. HTTPS SHOULD be used with any authorization scheme.

Requests MUST contain the Authorization header defining auth-scheme and auth-param: Authorization: auth-scheme auth-param.

Every request MUST contain the Accept header identifying the REST API version: Accept: application/vnd.uploadcare-v0.7+json.

There are two available authorization schemes:

  • For production: Uploadcare, a scheme where a signature, not your Secret API Key MUST be specified. Signatures SHOULD be generated on backend.
  • For quick tests: Uploadcare.Simple, a simple scheme where your Secret API Key MUST be specified in every request’s auth-param.