Ocoya API
Visit Ocoya
  • Getting Started
    • Introduction
    • Quick Start
  • Fundamentals
    • Authentication
    • Rate limits
    • Limitations
      • Date limitations
      • URL file limitations
      • Pagination limitations
  • Endpoints
    • Me
    • Workspaces
    • Social profiles
    • Posts
      • List posts
      • Create post
      • Update post
      • Delete post
  • Change log
    • 2025-05-16
    • 2024-10-10 (breaking)
  • Extra
    • HTTP status codes
Powered by GitBook

Last updated 4 days ago

Query parameters explained

Parameter
Type
Required
Information

page

integer

no

Page number

perPage

integer

no

Sample response

[
    {
        "id": "clhbatosn000x8kfenovaodu2",
        "postType": "REGULAR",
        "status": "POSTED",
        "scheduledAt": "2023-05-06T02:20:00.000Z",
        "posts": [
            {
                "provider": "GENERAL",
                "caption": "Nice post",
                "creatives": [],
            },
            {
                "provider": "FACEBOOK",
                "caption": "Nice post",
                "creatives": [],
            }
        ],
        "socialProfiles": [
            {
                "socialProfile": {
                    "id": "cm1utmu9b000qr59cy6mupxsp",
                    "provider": "facebook",
                    "name": "Ocoya Test",
                    "image": "https://graph.facebook.com/110495374807404/picture?type=normal"
                }
            }
        ]
    }
]

Number of records per page (must follow )

Pagination limitations

List all posts

get

Returns information about all posts

Authorizations
Query parameters
workspaceIdstringRequiredExample: cmayvq3hk00017apshay5qezu
statusesarray ยท enumOptionalExample: ["DRAFT"]Possible values:
pageintegerOptionalExample: 0
perPageintegerOptionalExample: 10
Responses
200
Success
500
Unknown error
get
GET /api/_public/v1/post HTTP/1.1
Host: app.ocoya.com
X-API-Key: YOUR_API_KEY
Accept: */*

No content