NextPay Docs
API Reference

Workspaces

Workspaces API endpoints

GET /workspaces

List workspaces

Authentication: Bearer token required

Responses

200 — List of workspaces

FieldTypeRequiredDescription
okbooleanYes
dataarrayYes
{
  "ok": true,
  "data": [
    {
      "id": "ws_abc123",
      "name": "Manila Office",
      "slug": "manila-office"
    }
  ]
}

Example

curl \
  -H "Authorization: Bearer YOUR_TOKEN" \
  https://api.nextpay.world/v1/workspaces

GET /workspaces/{id}

Get workspace details

Authentication: Bearer token required

Path Parameters

ParameterTypeRequiredDescription
idstringYesWorkspace ID

Responses

200 — Workspace details

FieldTypeRequiredDescription
okbooleanYes
dataobjectYes
{
  "ok": true,
  "data": {
    "id": "ws_abc123",
    "name": "Manila Office",
    "slug": "manila-office"
  }
}

Example

curl \
  -H "Authorization: Bearer YOUR_TOKEN" \
  https://api.nextpay.world/v1/workspaces/YOUR_WORKSPACE_ID

GET /workspaces/{id}/members

List workspace members

Authentication: Bearer token required

Path Parameters

ParameterTypeRequiredDescription
idstringYesWorkspace ID

Responses

200 — List of members

FieldTypeRequiredDescription
okbooleanYes
dataarrayYes
{
  "ok": true,
  "data": [
    {
      "id": "usr_abc123",
      "name": "Don Masakayan",
      "email": "don@nextfinancial.io",
      "roles": [
        "admin",
        "member"
      ]
    }
  ]
}

Example

curl \
  -H "Authorization: Bearer YOUR_TOKEN" \
  https://api.nextpay.world/v1/workspaces/YOUR_WORKSPACE_ID/members

POST /workspaces/{id}/members

Add a workspace member

Authentication: Bearer token required

Path Parameters

ParameterTypeRequiredDescription
idstringYesWorkspace ID

Request Body

FieldTypeRequiredDescription
emailstringYes
rolestringYes

Example Request

{
  "email": "juan@nextfinancial.io",
  "role": "member"
}

Responses

200 — Member added

FieldTypeRequiredDescription
okbooleanYes
dataobjectYes
{
  "ok": true,
  "data": {
    "workspace_id": "ws_abc123",
    "email": "juan@nextfinancial.io",
    "role": "member"
  }
}

Example

curl -X POST \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"email":"juan@nextfinancial.io","role":"member"}' \
  https://api.nextpay.world/v1/workspaces/YOUR_WORKSPACE_ID/members

DELETE /workspaces/{id}/members/{userId}

Remove a workspace member

Authentication: Bearer token required

Path Parameters

ParameterTypeRequiredDescription
idstringYesWorkspace ID
userIdstringYesUser ID to remove

Responses

200 — Member removed

FieldTypeRequiredDescription
okbooleanYes
dataobjectYes
{
  "ok": true,
  "data": {
    "workspace_id": "ws_abc123",
    "user_id": "usr_def456"
  }
}

Example

curl -X DELETE \
  -H "Authorization: Bearer YOUR_TOKEN" \
  https://api.nextpay.world/v1/workspaces/YOUR_WORKSPACE_ID/members/YOUR_USER_ID

GET /workspaces/{id}/roles

List workspace roles

Authentication: Bearer token required

Path Parameters

ParameterTypeRequiredDescription
idstringYesWorkspace ID

Responses

200 — List of roles

FieldTypeRequiredDescription
okbooleanYes
dataarrayYes
{
  "ok": true,
  "data": [
    {
      "key": "admin",
      "name": "Admin",
      "color": "blue",
      "permissions": [
        "ws.members.read",
        "ws.members.write"
      ]
    }
  ]
}

Example

curl \
  -H "Authorization: Bearer YOUR_TOKEN" \
  https://api.nextpay.world/v1/workspaces/YOUR_WORKSPACE_ID/roles

POST /workspaces/{id}/roles

Assign a role

Authentication: Bearer token required

Path Parameters

ParameterTypeRequiredDescription
idstringYesWorkspace ID

Request Body

FieldTypeRequiredDescription
user_idstringYes
rolestringYes

Example Request

{
  "user_id": "usr_def456",
  "role": "admin"
}

Responses

200 — Role assigned

FieldTypeRequiredDescription
okbooleanYes
dataobjectYes
{
  "ok": true,
  "data": {
    "workspace_id": "ws_abc123",
    "user_id": "usr_def456",
    "role": "admin"
  }
}

Example

curl -X POST \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"user_id":"usr_def456","role":"admin"}' \
  https://api.nextpay.world/v1/workspaces/YOUR_WORKSPACE_ID/roles

DELETE /workspaces/{id}/roles/{userId}/{role}

Remove a role

Authentication: Bearer token required

Path Parameters

ParameterTypeRequiredDescription
idstringYesWorkspace ID
userIdstringYesUser ID
rolestringYesRole key to remove

Responses

200 — Role removed

FieldTypeRequiredDescription
okbooleanYes
dataobjectYes
{
  "ok": true,
  "data": {
    "workspace_id": "ws_abc123",
    "user_id": "usr_def456",
    "role": "admin"
  }
}

Example

curl -X DELETE \
  -H "Authorization: Bearer YOUR_TOKEN" \
  https://api.nextpay.world/v1/workspaces/YOUR_WORKSPACE_ID/roles/YOUR_USER_ID/admin

On this page