Account

List Account Users

GET /v1/account/users

Lists all users in the account. This endpoint supports filtering and pagination to retrieve a subset of users based on the query parameters provided.

Parameters

NAME TYPE IN DESCRIPTION DEFAULT VALUE
searchMask string query A filter by name or email. None
take int32 query The number of users to return in the response. 20
skip int32 query The number of users to skip before returning results. Used for pagination. 0

Responses

Code Message Action
200 OK Returns a list of users in the account

Response Example:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18

{
  "data": [
    {
      "id": 0,
      "email": "string",
      "fullName": "string",
      "type": "Administrator",
      "workspaces": [
        {
          "workspaceId": 0,
          "roleName": "string",
          "roleId": 0
        }
      ]
    }
  ],
  "hasMore": true
}

Request Example

1
2

curl -X GET "https://api.skyvia.com/v1/account/users?take=20&skip=0" \
  -H "Authorization: <access_token>"

Delete Account User

DELETE /v1/account/users

Deletes a user from the account based on the provided email. The email must be provided in the request body to identify which user to delete.

Request Body

NAME TYPE IN DESCRIPTION
email string body The email of the user to delete.

Request Body Example:

1
2
3

{
  "email": "string"
}

Responses

Code Message Action
200 OK Confirms that the user was deleted.

Request Example

1
2
3
4
5
6

curl -X DELETE "https://api.skyvia.com/v1/account/users" \
  -H "Authorization: <access_token>" \
  -H "Content-Type: application/json" \
  -d '{
        "email": "[email protected]"
      }'

List Account Invitations

GET /v1/account/invitations

Lists all pending invitations in the account. This endpoint supports pagination to retrieve a subset of invitations based on the query parameters provided.

Parameters

NAME TYPE IN DESCRIPTION DEFAULT VALUE
take int32 query The number of invitations to return in the response. 20
skip int32 query The number of invitations to skip before returning results. Used for pagination. 0

Responses

Code Message Action
200 OK Returns a list of pending invitations in the account.

Response Example:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20

{
  "data": [
    {
      "id": 0,
      "email": "string",
      "type": "Administrator",
      "workspaces": [
        {
          "workspaceId": 0,
          "roleName": "string",
          "roleId": 0
        }
      ],
      "invitationDate": "2024-10-02T14:15:30Z",
      "userId": 0,
      "fullName": "string"
    }
  ],
  "hasMore": true
}

Request Example

1
2

curl -X GET "https://api.simple.com/v1/account/invitations?take=20&skip=0" \
  -H "Authorization: <access_token>"

Create Account Invitation

POST /v1/account/invitations

Sends an invitation to a new user to join the account. The request body must include the user’s email, user type, and the workspace details.

Request Body

NAME TYPE IN DESCRIPTION
email string body The email address of the user to invite.
userType string body The type of the user (Administrator, Member).
workspaces array body A list of workspaces the user is invited to.
workspaces[].workspaceId int32 body The workspace ID where the user is invited.
workspaces[].roleId int32 body The role ID assigned to the user in the workspace.

Request Body Example:

1
2
3
4
5
6
7
8
9
10

{
  "email": "[email protected]",
  "userType": "Member",
  "workspaces": [
    {
      "workspaceId": 123,
      "roleId": 3
    }
  ]
}

Responses

Code Message Action
200 OK Confirms that the invitation was successfully sent.

Response Example:

1
2
3
4
5

{
  "email": "string",
  "status": "string",
  "invitationId": 0
}

Request Example

1
2
3
4
5
6
7
8
9
10
11
12
13

curl -X POST "https://api.skyvia.com/v1/account/invitations" \
  -H "Authorization: <access_token>" \
  -H "Content-Type: application/json" \
  -d '{
        "email": "[email protected]",
        "userType": "Member",
        "workspaces": [
          {
            "workspaceId": 123,
            "roleId": 3
          }
        ]
      }'

Resend Account Invitation

POST /v1/account/invitations/{invitationId}/resend

Resends an invitation to the specified user. The invitation is identified by the invitationId provided in the URL path.

Parameters

NAME TYPE IN DESCRIPTION
invitationId int32 path The ID of the invitation to resend.

Responses

Code Message Action
200 OK Confirms that the invitation has been successfully resent.

Response Example:

1
2
3
4
5

{
  "email": "string",
  "status": "string",
  "invitationId": 0
}

Request Example

1
2

curl -X POST "https://api.simple.com/v1/account/invitations/123/resend" \
  -H "Authorization: <access_token>"

Delete Account Invitation

DELETE /v1/account/invitations/{invitationId}

Deletes a pending invitation from the account. The invitation is identified by the invitationId provided in the URL path.

Parameters

NAME TYPE IN DESCRIPTION
invitationId int32 path The ID of the invitation to delete.

Responses

Code Message Action
200 OK Confirms that the invitation was deleted.

Request Example

1
2

curl -X DELETE "https://api.simple.com/v1/account/invitations/123" \
  -H "Authorization: <access_token>"

On This Page