Merge API Documentation

curl -X POST https://api.merge.dev/api/filestorage/v1/folders \
     -H "X-Account-Token: X-Account-Token" \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json" \
     -d '{
  "model": {}
}'

{
  "model": {
    "id": "e021f7a7-74fc-4487-8e12-14180c92d3b7",
    "remote_id": "14",
    "created_at": "2021-09-15T00:00:00Z",
    "modified_at": "2021-10-16T00:00:00Z",
    "name": "R&D",
    "folder_url": "https://drive.com/1234",
    "size": 2738000,
    "description": "All things R&D related at Merge!",
    "parent_folder": "47ce474c-asdf-34a2-754r-629f799f7d31",
    "drive": "31ce474c-asdf-34a2-754r-629f799f7d12",
    "permissions": [
      {
        "id": "105b9265-0d52-4e5c-bb88-0cb681ec77f6",
        "remote_id": "102895",
        "created_at": "2020-03-31T00:00:00Z",
        "modified_at": "2020-06-20T00:00:00Z",
        "user": "21ce474c-asdf-34a2-754r-629f799f7d12",
        "type": "USER",
        "roles": [
          "OWNER"
        ]
      },
      {
        "id": "a77ac1b4-a04f-4baa-a388-de3c0c173e1c",
        "created_at": "2020-03-31T00:00:00Z",
        "modified_at": "2020-06-20T00:00:00Z",
        "group": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "type": "GROUP",
        "roles": [
          "READ"
        ]
      }
    ],
    "remote_created_at": "2024-02-02T00:00:00Z",
    "remote_updated_at": "2024-06-10T00:00:00Z",
    "remote_was_deleted": true,
    "field_mappings": {
      "organization_defined_targets": {
        "custom_key": "custom_value"
      },
      "linked_account_defined_targets": {
        "custom_key": "custom_value"
      }
    },
    "remote_data": [
      {
        "path": "/folders"
      }
    ]
  },
  "warnings": [
    {
      "title": "Unrecognized Field",
      "detail": "An unrecognized field, age, was passed in with request data.",
      "problem_type": "UNRECOGNIZED_FIELD",
      "source": {
        "pointer": "/age"
      },
      "block_merge_link": true,
      "raw_error": "string",
      "error_code": 1
    }
  ],
  "errors": [
    {
      "title": "Missing Required Field",
      "detail": "custom_fields is a required field on model.",
      "problem_type": "MISSING_REQUIRED_FIELD",
      "source": {
        "pointer": "/model/custom_fields"
      },
      "block_merge_link": true,
      "raw_error": "string",
      "error_code": 1
    }
  ],
  "logs": [
    {
      "log_id": "99433219-8017-4acd-bb3c-ceb23d663832",
      "dashboard_view": "https://app.merge.dev/logs/99433219-8017-4acd-bb3c-ceb23d663832",
      "log_summary": {
        "url": "www.exampleintegration.com/api/v1/exampleapi",
        "method": "POST",
        "status_code": 200
      }
    }
  ]
}

Creates a Folder object with the given values.

Authentication

AuthorizationBearer

Token-based authentication with required prefix “Bearer”

Query parameters

is_debug_modebooleanOptional

Whether to include debug fields (such as log file links) in the response.

run_asyncbooleanOptional

Whether or not third-party updates should be run asynchronously.

Request

This endpoint expects an object.

modelobjectRequired

Description

The Folder object is used to represent a collection of files and/or folders in the workspace. Could be within a drive, if it exists.

Usage Example

Fetch from the GET /api/filestorage/v1/folders endpoint and view their folders.

Response

modelobject

Description

The Folder object is used to represent a collection of files and/or folders in the workspace. Could be within a drive, if it exists.

Usage Example

Fetch from the GET /api/filestorage/v1/folders endpoint and view their folders.

warningslist of objects

errorslist of objects

logslist of objects

/folders

Authentication

Headers

Query parameters

Request

Description

Usage Example

Response

Description

Usage Example

Field support by integration