Download OpenAPI specification:Download
Integrate Magma into your workflow. Fetch and upload assets, manage teams and feedback.
API is available for all paid Artspaces. To get the API token go to the API page under Profile.
For commercial questions please contact [email protected].
Glossary:
Resources:
{- "success": true,
- "processingTime": 0,
- "statusCode": 0,
- "data": [
- {
- "_id": "string",
- "name": "string",
- "owner": {
- "_id": null,
- "name": null
}, - "pro": null,
- "featureFlags": [
- "string"
], - "slug": null,
- "authorizations": [
- "read_only"
], - "projects": [
- {
- "_id": "string",
- "team": "string",
- "name": "string",
- "shareType": 0
}
]
}
]
}
{- "success": true,
- "processingTime": 0,
- "statusCode": 0,
- "_id": "string",
- "name": "string",
- "owner": {
- "_id": null,
- "name": null
}, - "pro": null,
- "featureFlags": [
- "string"
], - "slug": null,
- "authorizations": [
- "read_only"
], - "projects": [
- {
- "_id": "string",
- "team": "string",
- "name": "string",
- "shareType": 0
}
]
}
id required | string Team Id |
name | string |
{- "name": "string"
}
{- "success": true,
- "processingTime": 0,
- "statusCode": 0
}
[- {
- "permission": "read_only",
- "privilege": 0,
- "status": "sent"
}
]
id required | string Team Id |
memberId required | string Team member's user Id |
permission | string Enum: "read_only" "read_write" |
{- "permission": "read_only"
}
name required | string |
team required | string |
{- "name": "string",
- "team": "string"
}
{- "success": true,
- "processingTime": 0,
- "statusCode": 0,
- "data": {
- "_id": "string",
- "team": "string",
- "name": "string",
- "shareType": 0
}
}
id required | string Project Id |
folder | string _id of folder |
{- "success": true,
- "processingTime": 0,
- "statusCode": 0,
- "data": {
- "_id": "string",
- "team": "string",
- "name": "string",
- "shareType": 0,
- "entities": [
- {
- "_id": "string",
- "shortId": "string",
- "privateId": "string",
- "name": "string",
- "author": {
- "name": "string",
- "_id": "string",
- "avatar": "string"
}, - "collaborators": [
- {
- "user": "string",
- "accessInfo": 0
}
], - "permission": "read_only",
- "accessInfo": 0,
- "teamAccess": 0,
- "createdAt": "2019-08-24",
- "updatedAt": "2019-08-24",
- "archived": true
}
]
}
}
id required | string Project Id |
name required | string |
{- "name": "string"
}
{- "success": true,
- "processingTime": 0,
- "statusCode": 0
}
[- {
- "_id": "string",
- "shortId": "string",
- "privateId": "string",
- "name": "string",
- "author": {
- "name": "string",
- "_id": "string",
- "avatar": "string"
}, - "collaborators": [
- {
- "user": "string",
- "accessInfo": 0
}
], - "permission": "read_only",
- "accessInfo": 0,
- "teamAccess": 0,
- "createdAt": "2019-08-24",
- "updatedAt": "2019-08-24",
- "archived": true
}
]
type | "Folder" |
name required | string |
project | string _id of project |
team | string _id of team |
{- "type": null,
- "name": "string",
- "project": "string",
- "team": "string"
}
project required | string |
entities required | Array of strings Array of entity short ids (entity.shortId) |
{- "project": "string",
- "entities": [
- "string"
]
}
{- "failure": {
- "id": "string",
- "error": "string"
}, - "success": [
- "string"
]
}
{- "type": null,
- "children": 0,
- "_id": "string",
- "shortId": "string",
- "privateId": "string",
- "name": "string",
- "author": {
- "name": "string",
- "_id": "string",
- "avatar": "string"
}, - "collaborators": [
- {
- "user": "string",
- "accessInfo": 0
}
], - "permission": "read_only",
- "accessInfo": 0,
- "teamAccess": 0,
- "createdAt": "2019-08-24",
- "updatedAt": "2019-08-24",
- "archived": true
}