Get list of service accounts

GET /v1/organizations/:organizationId/service-accounts/

Get list of service accounts

Request

Add parameter in header authorization

Example: Authorization: Bearer <token>

organizationId string

required

Entity Id or Slug

Match pattern: ^(([a-fA-F0-9]{24})|([a-zA-Z0-9\\-]{3,}))$

page integer

optional

Page number

limit integer

optional

Number of elements by page

sort string

optional

Match pattern: ^[\w.]*((:asc)|(:desc))?$

Responses

200 Response application/json

status boolean optional

data object optional

items array [object] optional

id string optional

Entity Id

Match pattern: ^[a-fA-F0-9]{24}$

organization string optional

Entity Id

Match pattern: ^[a-fA-F0-9]{24}$

email string optional

≤ 256 characters · Format: email

bearer string optional

≤ 128 characters

role string optional

admin editor viewer unassigned

updatedAt string optional

Format: date-time

createdAt string optional

Format: date-time

totalDocs integer optional

limit integer optional

hasPrevPage boolean optional

hasNextPage boolean optional

page integer optional

totalPages integer optional

prevPage integer optional

nextPage integer optional

lean boolean optional

{
    "status": true,
    "data": {
        "items": [
            {
                "id": "string",
                "organization": "string",
                "email": "user@example.com",
                "bearer": "string",
                "role": "admin",
                "updatedAt": "2024-01-01T00: 00:00Z",
                "createdAt": "2024-01-01T00: 00:00Z"
            }
        ],
        "totalDocs": 0,
        "limit": 0,
        "hasPrevPage": true,
        "hasNextPage": true,
        "page": 0,
        "totalPages": 0,
        "prevPage": 0,
        "nextPage": 0,
        "lean": true
    }
}

401 Response application/json

status boolean optional

false

error object optional

code number optional

4004

message string optional

Invalid Token

{
    "status": false,
    "error": {
        "code": 4002,
        "message": "No auth token"
    }
}

404 Response application/json

status boolean optional

false

error object optional

code number optional

3001

message string optional

Entity not found

{
    "status": false,
    "error": {
        "code": 3001,
        "message": "Entity not found"
    }
}